diff --git a/.vs/slnx.sqlite b/.vs/slnx.sqlite new file mode 100644 index 00000000000..8f7dd7f4f72 Binary files /dev/null and b/.vs/slnx.sqlite differ diff --git a/backend/docs/api_data.js b/backend/docs/api_data.js new file mode 100644 index 00000000000..a37d5ca5843 --- /dev/null +++ b/backend/docs/api_data.js @@ -0,0 +1,14845 @@ +define({ "api": [ + { + "type": "get", + "url": "/version", + "title": "Application version", + "name": "printVersion", + "group": "3D_Repo", + "description": "

Show current application version.

", + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "String", + "optional": false, + "field": "VERSION", + "description": "

API service version

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "unity", + "description": "

Unity viewer version

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "navis", + "description": "

Autodesk Navisworks version

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "unitydll", + "description": "

Unity viewer version

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"VERSION\": \"2.20.1\",\n\t\"unity\": {\n\t\t\"current\": \"2.20.0\",\n\t\t\"supported\": []\n\t},\n\t\"navis\": {\n\t\t\"current\": \"2.16.0\",\n\t\t\"supported\": [\n\t\t\t\"2.8.0\"\n\t\t]\n\t},\n\t\"unitydll\": {\n\t\t\"current\": \"2.8.0\",\n\t\t\"supported\": []\n\t}\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/auth.js", + "groupTitle": "3D_Repo" + }, + { + "type": "post", + "url": "/:teamspace/permissions", + "title": "Assign permissions", + "name": "createPermission", + "group": "Account_Permission", + "description": "

Assign account level permission to a user

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "user", + "description": "

User to assign permissions to

" + }, + { + "group": "Request body", + "type": "String[]", + "optional": false, + "field": "permissions", + "description": "

List of account level permissions

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "String", + "optional": false, + "field": "user", + "description": "

User

" + }, + { + "group": "200", + "type": "String[]", + "optional": false, + "field": "permissions", + "description": "

Account Level Permission types

" + } + ] + }, + "examples": [ + { + "title": "Success-Response:", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"user\": \"bob\",\n\t\t\"permissions\": [\n\t\t\t\"create_project\"\n\t\t]\n\t}\n]", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /acme/permissions HTTP/1.1\n{\n\t\"user\": \"bob\",\n\t\"permissions\": [\n\t\t\"create_project\"\n\t]\n}", + "type": "post" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/accountPermission.js", + "groupTitle": "Account_Permission" + }, + { + "type": "delete", + "url": "/:teamspace/permissions/:user", + "title": "Revoke permissions", + "name": "deletePermission", + "group": "Account_Permission", + "description": "

Revoke all permissions from a user.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user", + "description": "

User to delete

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "DELETE /acme/permissions/alice HTTP/1.1", + "type": "delete" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/accountPermission.js", + "groupTitle": "Account_Permission" + }, + { + "type": "get", + "url": "/:teamspace/permissions", + "title": "List all permissions", + "name": "listPermissions", + "group": "Account_Permission", + "description": "

Get a list of all account permission objects for a teamspace

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "String", + "optional": false, + "field": "user", + "description": "

User

" + }, + { + "group": "200", + "type": "String[]", + "optional": false, + "field": "permissions", + "description": "

Account level permissions

" + } + ] + }, + "examples": [ + { + "title": "Success-Response:", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"user\": \"alice\",\n\t\t\"permissions\": [\n\t\t\t\"teamspace_admin\"\n\t\t]\n\t},\n\t{\n\t\t\"user\": \"bob\",\n\t\t\"permissions\": [\n\t\t\t\"create_project\"\n\t\t]\n\t}\n]", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/permissions HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/accountPermission.js", + "groupTitle": "Account_Permission" + }, + { + "type": "put", + "url": "/:teamspace/permissions/:user", + "title": "Update permissions", + "name": "updatePermission", + "group": "Account_Permission", + "description": "

Update permissions assignment for a user.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user", + "description": "

User to update

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String[]", + "optional": false, + "field": "permissions", + "description": "

List of account level permissions

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "String[]", + "optional": false, + "field": "permissions", + "description": "

List of account level permissions

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"permissions\": [\n\t\t\"teamspace_admin\"\n\t]\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "PUT /acme/permissions/alice HTTP/1.1\n{\n\t\"permissions\": [\n\t\t\"teamspace_admin\"\n\t]\n}", + "type": "put" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/accountPermission.js", + "groupTitle": "Account_Permission" + }, + { + "type": "post", + "url": "/forgot-password", + "title": "Forgot password", + "name": "forgotPassword", + "group": "Account", + "description": "

Send a password reset link to account's e-mail.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "username", + "description": "

Account username

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "email", + "description": "

E-mail address registered with account

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage (with username):", + "content": "POST /forgot-password HTTP/1.1\n{\n\t\"username: \"alice\"\n}", + "type": "get" + }, + { + "title": "Example usage (with e-mail):", + "content": "POST /forgot-password HTTP/1.1\n{\n\t\"email: \"alice@acme.co.uk\"\n}", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/auth.js", + "groupTitle": "Account" + }, + { + "type": "get", + "url": "/:user/avatar", + "title": "Get avatar", + "name": "getAvatar", + "group": "Account", + "description": "

Get user avatar.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user", + "description": "

User

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "Object", + "optional": false, + "field": "avatar", + "description": "

User Avatar Image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "json" + } + ] + }, + "error": { + "fields": { + "404": [ + { + "group": "404", + "optional": false, + "field": "USER_DOES_NOT_HAVE_AVATAR", + "description": "

User does not have an avatar

" + } + ] + }, + "examples": [ + { + "title": "Error-Response", + "content": "HTTP/1.1 404 Not Found\n{\n\t\"message\": \"User does not have an avatar\",\n\t\"status\": 404,\n\t\"code\": \"USER_DOES_NOT_HAVE_AVATAR\",\n\t\"place\": \"GET /alice/avatar\"\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /alice/avatar HTTP/1.1", + "type": "put" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/auth.js", + "groupTitle": "Account" + }, + { + "type": "get", + "url": "/:user.json", + "title": "List account information", + "name": "listInfo", + "group": "Account", + "description": "

Account information and list of projects grouped by teamspace that the user has access to.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user", + "description": "

User

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "Object[]", + "optional": false, + "field": "accounts", + "description": "

User account

" + }, + { + "group": "200", + "type": "Object", + "optional": false, + "field": "billingInfo", + "description": "

Billing information

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "email", + "description": "

User e-mail address

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "firstName", + "description": "

First name

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "lastName", + "description": "

Surname

" + }, + { + "group": "200", + "type": "Boolean", + "optional": false, + "field": "hasAvatar", + "description": "

True if user account has an avatar

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"accounts\": [\n\t\t{\n\t\t\t\"account\": \"repoman\",\n\t\t\t\"models\": [\n\t\t\t\t{\n\t\t\t\t\t\"permissions\": [\n\t\t\t\t\t\t\"change_model_settings\",\n\t\t\t\t\t\t\"upload_files\",\n\t\t\t\t\t\t\"create_issue\",\n\t\t\t\t\t\t\"comment_issue\",\n\t\t\t\t\t\t\"view_issue\",\n\t\t\t\t\t\t\"view_model\",\n\t\t\t\t\t\t\"download_model\",\n\t\t\t\t\t\t\"edit_federation\",\n\t\t\t\t\t\t\"delete_federation\",\n\t\t\t\t\t\t\"delete_model\",\n\t\t\t\t\t\t\"manage_model_permission\"\n\t\t\t\t\t],\n\t\t\t\t\t\"model\": \"00000000-0000-0000-0000-000000000000\",\n\t\t\t\t\t\"name\": \"ufo\",\n\t\t\t\t\t\"status\": \"ok\",\n\t\t\t\t\t\"timestamp\": \"2016-07-26T15:52:11.000Z\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"fedModels\": [],\n\t\t\t\"isAdmin\": true,\n\t\t\t\"permissions\": [\n\t\t\t\t\"teamspace_admin\"\n\t\t\t],\n\t\t\t\"quota\": {\n\t\t\t\t\"spaceLimit\": 10485760,\n\t\t\t\t\"collaboratorLimit\": 5,\n\t\t\t\t\"spaceUsed\": 12478764\n\t\t\t},\n\t\t\t\"projects\": []\n\t\t},\n\t\t{\n\t\t\t\"account\": \"breakingbad\",\n\t\t\t\"models\": [\n\t\t\t\t{\n\t\t\t\t\t\"permissions\": [\n\t\t\t\t\t\t\"view_issue\",\n\t\t\t\t\t\t\"view_model\",\n\t\t\t\t\t\t\"upload_files\",\n\t\t\t\t\t\t\"create_issue\"\n\t\t\t\t\t],\n\t\t\t\t\t\"model\": \"00000000-0000-0000-0000-000000000001\",\n\t\t\t\t\t\"name\": \"homelab\",\n\t\t\t\t\t\"status\": \"ok\",\n\t\t\t\t\t\"timestamp\": null\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"fedModels\": [\n\t\t\t\t{\n\t\t\t\t\t\"federate\": true,\n\t\t\t\t\t\"permissions\": [\n\t\t\t\t\t\t\"change_model_settings\",\n\t\t\t\t\t\t\"upload_files\",\n\t\t\t\t\t\t\"create_issue\",\n\t\t\t\t\t\t\"comment_issue\",\n\t\t\t\t\t\t\"view_issue\",\n\t\t\t\t\t\t\"view_model\",\n\t\t\t\t\t\t\"download_model\",\n\t\t\t\t\t\t\"edit_federation\",\n\t\t\t\t\t\t\"delete_federation\",\n\t\t\t\t\t\t\"delete_model\",\n\t\t\t\t\t\t\"manage_model_permission\"\n\t\t\t\t\t],\n\t\t\t\t\t\"model\": \"00000000-0000-0000-0000-000000000003\",\n\t\t\t\t\t\"name\": \"fed1\",\n\t\t\t\t\t\"status\": \"ok\",\n\t\t\t\t\t\"timestamp\": \"2017-05-11T12:49:59.000Z\",\n\t\t\t\t\t\"subModels\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"database\": \"breakingbad\",\n\t\t\t\t\t\t\t\"model\": \"00000000-0000-0000-0000-000000000001\",\n\t\t\t\t\t\t\t\"name\": \"homelab\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"database\": \"breakingbad\",\n\t\t\t\t\t\t\t\"model\": \"00000000-0000-0000-0000-000000000002\",\n\t\t\t\t\t\t\t\"name\": \"laundrylab\"\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"projects\": [\n\t\t\t\t{\n\t\t\t\t\t\"_id\": \"58f78c8ededbb13a982114ee\",\n\t\t\t\t\t\"name\": \"folder1\",\n\t\t\t\t\t\"permission\": [],\n\t\t\t\t\t\"models\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"permissions\": [\n\t\t\t\t\t\t\t\t\"view_issue\",\n\t\t\t\t\t\t\t\t\"view_model\",\n\t\t\t\t\t\t\t\t\"upload_files\",\n\t\t\t\t\t\t\t\t\"create_issue\"\n\t\t\t\t\t\t\t],\n\t\t\t\t\t\t\t\"model\": \"00000000-0000-0000-0000-000000000004\",\n\t\t\t\t\t\t\t\"name\": \"laundrylab\",\n\t\t\t\t\t\t\t\"status\": \"ok\",\n\t\t\t\t\t\t\t\"timestamp\": null\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t],\n\t\"billingInfo\": {\n\t\t\"countryCode\": \"US\",\n\t\t\"postalCode\": \"0\",\n\t\t\"line2\": \"123\",\n\t\t\"city\": \"123\",\n\t\t\"line1\": \"123\",\n\t\t\"vat\": \"000\",\n\t\t\"company\": \"Universal Pictures\",\n\t\t\"_id\": \"59145aedf4f613668fba0f98\"\n\t},\n\t\"email\":\"alice@acme.co.uk\",\n\t\"firstName\":\"Alice\",\n\t\"lastName\":\"Allen\",\n\t\"hasAvatar\": true,\n\t\"jobs\": [\n\t\t{\n\t\t\t\"_id\": \"Director\"\n\t\t},\n\t\t{\n\t\t\t\"_id\": \"Actor\"\n\t\t},\n\t\t{\n\t\t\t\"_id\": \"Producer\n\t\t}\n\t]\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /alice.json HTTP/1.1", + "type": "delete" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/auth.js", + "groupTitle": "Account" + }, + { + "type": "put", + "url": "/:user/password", + "title": "Reset password", + "name": "resetPassword", + "group": "Account", + "description": "

Reset user account password. New password must be different.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user", + "description": "

User account

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "oldPassword", + "description": "

Old password

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "newPassword", + "description": "

New password

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "token", + "description": "

Password reset token

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "optional": false, + "field": "account", + "description": "

Account username

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"account\":\"alice\"\n}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "Error 4xx": [ + { + "group": "Error 4xx", + "optional": false, + "field": "TOKEN_INVALID", + "description": "

Token is invalid or has expired

" + } + ] + }, + "examples": [ + { + "title": "Error-Response", + "content": "HTTP/1.1 400 Bad Request\n{\n\t\"message\":\"Token is invalid or expired\",\n\t\"status\":400,\n\t\"code\":\"TOKEN_INVALID\",\n\t\"value\":59,\n\t\"place\": \"PUT /alice/password\"\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage (with old password):", + "content": "PUT /alice/password HTTP/1.1\n{\n\t\"oldPassword\":\"AW96B6\",\n\t\"newPassword\":\"TrustNo1\"\n}", + "type": "post" + }, + { + "title": "Example usage (with token):", + "content": "PUT /alice/password HTTP/1.1\n{\n\t\"token\":\"1234567890\",\n\t\"newPassword\":\"TrustNo1\"\n}", + "type": "post" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/auth.js", + "groupTitle": "Account" + }, + { + "type": "post", + "url": "/:user", + "title": "Sign up", + "name": "signUp", + "group": "Account", + "description": "

Sign up for a new user account.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user", + "description": "

New account username to register

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "password", + "description": "

Password

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "email", + "description": "

Valid e-mail address

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "firstName", + "description": "

First name

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "lastName", + "description": "

Surname

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "company", + "description": "

Company

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "jobTitle", + "description": "

Job title

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "countryCode", + "description": "

ISO 3166-1 alpha-2

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "captcha", + "description": "

Google reCAPTCHA response token

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "optional": false, + "field": "account", + "description": "

New Account username

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"account\":\"alice\"\n}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "Error 4xx": [ + { + "group": "Error 4xx", + "optional": false, + "field": "SIGN_UP_PASSWORD_MISSING", + "description": "

Password is missing

" + } + ] + }, + "examples": [ + { + "title": "Error-Response", + "content": "\nHTTP/1.1 400 Bad Request\n{\n\t\"message\": \"Password is missing\",\n\t\"status\": 400,\n\t\"code\": \"SIGN_UP_PASSWORD_MISSING\",\n\t\"value\": 57,\n\t\"place\": \"POST /nabile\"\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /alice HTTP/1.1\n{\n\t\"email\":\"alice@acme.co.uk\",\n\t\"password\":\"AW96B6\",\n\t\"firstName\":\"Alice\",\n\t\"lastName\":\"Allen\",\n\t\"company\":\"Acme Corporation\",\n\t\"countryCode\":\"GB\",\n\t\"jobTitle\":\"CEO\",\n\t\"captcha\":\"1234567890qwertyuiop\"\n}", + "type": "post" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/auth.js", + "groupTitle": "Account" + }, + { + "type": "put", + "url": "/:user", + "title": "Update user account", + "name": "updateUser", + "group": "Account", + "description": "

Update account information.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user", + "description": "

Account username

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "email", + "description": "

Valid e-mail address

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "firstName", + "description": "

First name

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "lastName", + "description": "

Surname

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "optional": false, + "field": "account", + "description": "

Account username

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"account\":\"alice\"\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "PUT /alice HTTP/1.1\n{\n\t\"email\":\"alice@3drepo.org\",\n\t\"firstName\":\"Alice\",\n\t\"lastName\":\"Anderson\"\n}", + "type": "post" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/auth.js", + "groupTitle": "Account" + }, + { + "type": "post", + "url": "/:user/avatar", + "title": "Upload avatar", + "name": "uploadAvatar", + "group": "Account", + "description": "

Upload a new avatar image. Only multipart form data content type will be accepted.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user", + "description": "

User

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "File", + "optional": false, + "field": "file", + "description": "

Image to upload

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /alice/avatar HTTP/1.1\nContent-Type: multipart/form-data; boundary=----WebKitFormBoundaryN8dwXAkcO1frCHLf\n\n------WebKitFormBoundaryN8dwXAkcO1frCHLf\nContent-Disposition: form-data; name=\"file\"; filename=\"avatar.png\"\nContent-Type: image/png\n\n\n------WebKitFormBoundaryN8dwXAkcO1frCHLf--", + "type": "put" + } + ], + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "Object", + "optional": false, + "field": "status", + "description": "

Status of Avatar upload.

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"status\":\"success\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/auth.js", + "groupTitle": "Account" + }, + { + "type": "post", + "url": "/:user/verify", + "title": "Verify", + "name": "verify", + "group": "Account", + "description": "

Verify an account after signing up.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user", + "description": "

Account username

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "token", + "description": "

Account verification token

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "optional": false, + "field": "account", + "description": "

Account username

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"account\":\"alice\"\n}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "Error 4xx": [ + { + "group": "Error 4xx", + "optional": false, + "field": "ALREADY_VERIFIED", + "description": "

User already verified

" + } + ] + }, + "examples": [ + { + "title": "Error-Response", + "content": "HTTP/1.1 400 Bad Request\n{\n\t\"message\": \"Already verified\",\n\t\"status\": 400,\n\t\"code\": \"ALREADY_VERIFIED\",\n\t\"value\": 60,\n\t\"place\": \"POST /alice/verify\"\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /alice/verify HTTP/1.1\n{\n\t\"token\":\"1234567890\"\n}", + "type": "post" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/auth.js", + "groupTitle": "Account" + }, + { + "type": "get", + "url": "/login", + "title": "Get current username", + "name": "checkLogin", + "group": "Authentication", + "description": "

Get the username of the logged in user.

", + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "String", + "optional": false, + "field": "username", + "description": "

Account username

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"username\": \"alice\"\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /login HTTP/1.1\n{}", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/auth.js", + "groupTitle": "Authentication" + }, + { + "type": "post", + "url": "/login", + "title": "Login", + "name": "login", + "group": "Authentication", + "description": "

3D Repo account login. Logging in generates a token that can be used for cookie-based authentication. To authentication subsequent API calls using cookie-based authentication, simply put the following into the HTTP header: Cookie: connect.sid=:sessionId

NOTE: If you use a modern browser’s XMLHttpRequest object to make API calls, you don’t need to take care of the authentication process after calling /login.

", + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "username", + "description": "

Account username

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "password", + "description": "

Account password

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "String", + "optional": false, + "field": "username", + "description": "

Account username

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\nset-cookie:connect.sid=12345678901234567890;\n{\n\t\"username\": \"alice\"\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /login HTTP/1.1\n{\n\t\"username\": \"alice\",\n\t\"password\": \"AW96B6\"\n}", + "type": "post" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/auth.js", + "groupTitle": "Authentication" + }, + { + "type": "post", + "url": "/logout", + "title": "Logout", + "name": "logout", + "group": "Authentication", + "description": "

Invalidate the authenticated session.

", + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "String", + "optional": false, + "field": "username", + "description": "

Account username

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"username\": \"alice\"\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /logout HTTP/1.1\n{}", + "type": "post" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/auth.js", + "groupTitle": "Authentication" + }, + { + "type": "post", + "url": "/:teamspace/:model/revision(/master/head|/:revId)/groups", + "title": "Create group", + "name": "createGroup", + "group": "Groups", + "description": "

Add a group to the model.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "revId", + "description": "

Revision ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "author", + "description": "

Username of group creator

" + }, + { + "group": "Request body", + "type": "Number[]", + "optional": false, + "field": "color", + "description": "

RGB colour values

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "description", + "description": "

Group description

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "name", + "description": "

Group name

" + }, + { + "group": "Request body", + "type": "Object[]", + "optional": false, + "field": "objects", + "description": "

List of objects in group

" + }, + { + "group": "Request body", + "type": "Object[]", + "optional": true, + "field": "rules", + "description": "

List of rules in group

" + }, + { + "group": "Request body", + "type": "Number[]", + "optional": true, + "field": "transformation", + "description": "

Flat 16 element array representation of 4x4 transformation matrix

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage (/master/head)", + "content": "POST /acme/00000000-0000-0000-0000-000000000000/revision/master/head/groups HTTP/1.1\n{\n\t\"name\":\"Group 1\",\n\t\"description\":\"This is the description text for the first group.\",\n\t\"author\":\"alice\",\n\t\"color\":[255,0,0],\n\t\"objects\":[\n\t\t{\n\t\t\t\"account\":\"acme\",\n\t\t\t\"model\":\"00000000-0000-0000-0000-000000000000\",\n\t\t\t\"shared_ids\":[\n\t\t\t\t\"24fdcf2d-b9eb-4fa2-a614-dfe2532493b3\",\n\t\t\t\t\"db18ef69-6d6e-49a0-846e-907346abb39d\",\n\t\t\t\t\"c532ff34-6669-4807-b7f3-6a0ffb17b027\",\n\t\t\t\t\"fec16ea6-bb7b-4f12-b39b-f06fe6bf041d\",\n\t\t\t\t\"3f881fa8-2b7b-443e-920f-396c1c85e903\"\n\t\t\t]\n\t\t}\n\t]\n}", + "type": "post" + }, + { + "title": "Example usage (/:revId)", + "content": "POST /acme/00000000-0000-0000-0000-000000000000/revision/00000000-0000-0000-0000-000000000001/groups HTTP/1.1\n{\n\t\"name\":\"Group 1\",\n\t\"description\":\"This is the description text for the first group.\",\n\t\"author\":\"alice\",\n\t\"color\":[255,0,0],\n\t\"objects\":[\n\t\t{\n\t\t\t\"account\":\"acme\",\n\t\t\t\"model\":\"00000000-0000-0000-0000-000000000000\",\n\t\t\t\"shared_ids\":[\n\t\t\t\t\"24fdcf2d-b9eb-4fa2-a614-dfe2532493b3\",\n\t\t\t\t\"db18ef69-6d6e-49a0-846e-907346abb39d\",\n\t\t\t\t\"c532ff34-6669-4807-b7f3-6a0ffb17b027\",\n\t\t\t\t\"fec16ea6-bb7b-4f12-b39b-f06fe6bf041d\",\n\t\t\t\t\"3f881fa8-2b7b-443e-920f-396c1c85e903\"\n\t\t\t]\n\t\t}\n\t]\n}", + "type": "post" + }, + { + "title": "Example usage (smart group)", + "content": "POST /acme/00000000-0000-0000-0000-000000000000/revision/master/head/groups HTTP/1.1\n{\n\t\"name\":\"Smart 1\",\n\t\"description\":\"This is a smart group of objects with type IfcWall or IfcDoor with area > 5.\",\n\t\"author\":\"alice\",\n\t\"color\":[255,0,0],\n\t\"objects\":[],\n\t\"rules\":[\n\t\t{\n\t\t\t\"field\": {\n\t\t\t\t\"operator\": \"IS\",\n\t\t\t\t\"values\": [\"Area\"]\n\t\t\t},\n\t\t\t\"operator\":\"GT\",\n\t\t\t\"values\":[5]\n\t\t},\n\t\t{\n\t\t\t\"field\": {\n\t\t\t\t\"operator\": \"IS\",\n\t\t\t\t\"values\": [\"IFC Type\"]\n\t\t\t},\n\t\t\t\"operator\":\"IS\",\n\t\t\t\"values\":[\n\t\t\t\t\"IfcWall\",\n\t\t\t\t\"IfcDoor\"\n\t\t\t]\n\t\t}\n\t]\n}", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response (normal group)", + "content": "HTTP/1.1 200 OK\n{\n\t\"_id\":\"00000000-0000-0000-0000-000000000002\",\n\t\"name\":\"Group 1\",\n\t\"description\":\"This is the description text for the first group.\",\n\t\"author\":\"alice\",\n\t\"createdAt\":\"2018-03-09T10:45:00.000Z\",\n\t\"color\":[255,0,0],\n\t\"objects\":[\n\t\t{\n\t\t\t\"account\":\"acme\",\n\t\t\t\"model\":\"00000000-0000-0000-0000-000000000000\",\n\t\t\t\"ifc_guids\":[],\n\t\t\t\"shared_ids\":[\n\t\t\t\t\"24fdcf2d-b9eb-4fa2-a614-dfe2532493b3\",\n\t\t\t\t\"db18ef69-6d6e-49a0-846e-907346abb39d\",\n\t\t\t\t\"c532ff34-6669-4807-b7f3-6a0ffb17b027\",\n\t\t\t\t\"fec16ea6-bb7b-4f12-b39b-f06fe6bf041d\",\n\t\t\t\t\"3f881fa8-2b7b-443e-920f-396c1c85e903\"\n\t\t\t]\n\t\t}\n\t],\n\t\"rules\":[]\n}", + "type": "json" + }, + { + "title": "Success-Response (smart group)", + "content": "HTTP/1.1 200 OK\n{\n\t\"_id\":\"00000000-0000-0000-0000-000000000004\",\n\t\"name\":\"Smart 1\",\n\t\"description\":\"This is a smart group of objects with type IfcWall or IfcDoor with area > 5.\",\n\t\"author\":\"alice\",\n\t\"createdAt\":\"2018-03-09T10:45:00.000Z\",\n\t\"color\":[255,0,0],\n\t\"objects\":[\n\t\t{\n\t\t\t\"account\":\"acme\",\n\t\t\t\"model\":\"00000000-0000-0000-0000-000000000000\",\n\t\t\t\"ifc_guids\":[],\n\t\t\t\"shared_ids\":[\n\t\t\t\t\"db18ef69-6d6e-49a0-846e-907346abb39d\",\n\t\t\t\t\"fec16ea6-bb7b-4f12-b39b-f06fe6bf041d\",\n\t\t\t\t\"3f881fa8-2b7b-443e-920f-396c1c85e903\"\n\t\t\t]\n\t\t}\n\t],\n\t\"rules\":[\n\t\t{\n\t\t\t\"field\": {\n\t\t\t\t\"operator\": \"IS\",\n\t\t\t\t\"values\": [\"Area\"]\n\t\t\t},\n\t\t\t\"operator\":\"GT\",\n\t\t\t\"values\":[5]\n\t\t},\n\t\t{\n\t\t\t\"field\": {\n\t\t\t\t\"operator\": \"IS\",\n\t\t\t\t\"values\": [\"IFC Type\"]\n\t\t\t},\n\t\t\t\"operator\":\"IS\",\n\t\t\t\"values\":[\n\t\t\t\t\"IfcWall\",\n\t\t\t\t\"IfcDoor\"\n\t\t\t]\n\t\t}\n\t]\n}", + "type": "json" + } + ], + "fields": { + "200": [ + { + "group": "200", + "type": "String", + "optional": false, + "field": "author", + "description": "

Username of group creator

" + }, + { + "group": "200", + "type": "Number[]", + "optional": false, + "field": "color", + "description": "

RGB colour values

" + }, + { + "group": "200", + "type": "Number", + "optional": false, + "field": "createdAt", + "description": "

Group creation timestamp in milliseconds

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "description", + "description": "

Group description

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "name", + "description": "

Group name

" + }, + { + "group": "200", + "type": "Object[]", + "optional": false, + "field": "objects", + "description": "

List of objects in group

" + }, + { + "group": "200", + "type": "Object[]", + "optional": false, + "field": "rules", + "description": "

List of rules in group

" + }, + { + "group": "200", + "type": "Number[]", + "optional": false, + "field": "transformation", + "description": "

Flat 16 element array representation of 4x4 transformation matrix

" + }, + { + "group": "200", + "type": "Number", + "optional": false, + "field": "updatedAt", + "description": "

Group update timestamp in milliseconds

" + }, + { + "group": "200", + "type": "Number", + "optional": false, + "field": "updatedBy", + "description": "

Username of last user to amend group

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "_id", + "description": "

Unique ID of group

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/group.js", + "groupTitle": "Groups", + "groupDescription": "

A grouping of model elements. Groups can either comprise of a set of manually defined elements or rules (smart group) that define the criteria for its elements.

" + }, + { + "type": "delete", + "url": "/:teamspace/:model/groups?ids=[GROUPS]", + "title": "Delete groups", + "name": "deleteGroups", + "group": "Groups", + "description": "

Delete groups.

", + "parameter": { + "fields": { + "Query": [ + { + "group": "Query", + "type": "String", + "optional": false, + "field": "GROUPS", + "description": "

Comma separated list of group IDs

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "String", + "optional": false, + "field": "status", + "description": "

Group deletion result (success|ERROR CODE)

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"status\":\"success\"\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage", + "content": "DELETE /acme/00000000-0000-0000-0000-000000000000/groups?ids=00000000-0000-0000-0000-000000000002,00000000-0000-0000-0000-000000000003 HTTP/1.1", + "type": "delete" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/group.js", + "groupTitle": "Groups", + "groupDescription": "

A grouping of model elements. Groups can either comprise of a set of manually defined elements or rules (smart group) that define the criteria for its elements.

" + }, + { + "type": "post", + "url": "/:teamspace/:model/groups/export", + "title": "Export Groups", + "name": "exportGroups", + "group": "Groups", + "description": "

This is a back-ported endpoint from V5. For details please see V5 documentation /docs/#/Federations/ExportFederationGroups

", + "version": "0.0.0", + "filename": "src/v4/routes/group.js", + "groupTitle": "Groups", + "groupDescription": "

A grouping of model elements. Groups can either comprise of a set of manually defined elements or rules (smart group) that define the criteria for its elements.

" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision(/master/head|/:revId)/groups/:groupId?[query]", + "title": "Find group", + "name": "findGroup", + "group": "Groups", + "description": "

Find a group.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "revId", + "description": "

Revision ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "groupId", + "description": "

Group ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "ifcguids", + "description": "

Flag that returns IFC GUIDs for group elements

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage (/master/head)", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/revision/master/head/groups/00000000-0000-0000-0000-000000000002 HTTP/1.1", + "type": "get" + }, + { + "title": "Example usage (/:revId)", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/revision/00000000-0000-0000-0000-000000000001/groups/00000000-0000-0000-0000-000000000002 HTTP/1.1", + "type": "get" + }, + { + "title": "Example usage (with IFC GUIDs)", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/revision/master/head/groups/00000000-0000-0000-0000-000000000004?ifcguids=true HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"author\":\"alice\",\n\t\"color\":[255,0,0],\n\t\"createdAt\":1520592300000,\n\t\"description\":\"This is the description text for the first group.\",\n\t\"name\":\"Group 1\",\n\t\"objects\":[\n\t\t{\n\t\t\t\"account\": \"acme\",\n\t\t\t\"model\": \"00000000-0000-0000-0000-000000000000\",\n\t\t\t\"ifc_guids\": [],\n\t\t\t\"shared_ids\": [\n\t\t\t\t\"24fdcf2d-b9eb-4fa2-a614-dfe2532493b3\",\n\t\t\t\t\"db18ef69-6d6e-49a0-846e-907346abb39d\",\n\t\t\t\t\"c532ff34-6669-4807-b7f3-6a0ffb17b027\",\n\t\t\t\t\"fec16ea6-bb7b-4f12-b39b-f06fe6bf041d\",\n\t\t\t\t\"3f881fa8-2b7b-443e-920f-396c1c85e903\"\n\t\t\t]\n\t\t}\n\t],\n\t\"updatedAt\":1552128300000,\n\t\"updatedBy\":\"alice\",\n\t\"_id\":\"00000000-0000-0000-0000-000000000002\"\n}", + "type": "json" + }, + { + "title": "Success-Response (with IFC GUIDs)", + "content": "HTTP/1.1 200 OK\n{\n\t\"author\":\"alice\",\n\t\"color\":[255,0,0],\n\t\"createdAt\":1520592300000,\n\t\"description\":\"This is a smart group of objects with type IfcWall or IfcDoor with area > 5.\",\n\t\"name\":\"Smart 1\",\n\t\"objects\":[\n\t\t{\n\t\t\t\"account\": \"acme\",\n\t\t\t\"model\": \"00000000-0000-0000-0000-000000000000\",\n\t\t\t\"ifc_guids\": [\n\t\t\t\t\"2cx1GdQ9fAgRIWgfhfBb84\",\n\t\t\t\t\"13NEEUJ8DEE8fEH0aHgm2z\",\n\t\t\t\t\"3OLNF2_DL6hfPgh8Bw7fI7\"\n\t\t\t],\n\t\t\t\"shared_ids\": [\n\t\t\t\t\"24fdcf2d-b9eb-4fa2-a614-dfe2532493b3\",\n\t\t\t\t\"db18ef69-6d6e-49a0-846e-907346abb39d\",\n\t\t\t\t\"c532ff34-6669-4807-b7f3-6a0ffb17b027\",\n\t\t\t\t\"fec16ea6-bb7b-4f12-b39b-f06fe6bf041d\",\n\t\t\t\t\"3f881fa8-2b7b-443e-920f-396c1c85e903\"\n\t\t\t]\n\t\t}\n\t],\n\t\"rules\":[\n\t\t{\n\t\t\t\"field\": {\n\t\t\t\t\"operator\": \"IS\",\n\t\t\t\t\"values\": [\"Area\"]\n\t\t\t},\n\t\t\t\"operator\":\"GT\",\n\t\t\t\"values\":[5]\n\t\t},\n\t\t{\n\t\t\t\"field\": {\n\t\t\t\t\"operator\": \"IS\",\n\t\t\t\t\"values\": [\"IFC Type\"]\n\t\t\t},\n\t\t\t\"operator\":\"IS\",\n\t\t\t\"values\":[\n\t\t\t\t\"IfcWall\",\n\t\t\t\t\"IfcDoor\"\n\t\t\t]\n\t\t}\n\t],\n\t\"updatedAt\":1552128300000,\n\t\"updatedBy\":\"alice\",\n\t\"_id\":\"00000000-0000-0000-0000-000000000004\"\n}", + "type": "json" + } + ], + "fields": { + "200": [ + { + "group": "200", + "type": "String", + "optional": false, + "field": "author", + "description": "

Username of group creator

" + }, + { + "group": "200", + "type": "Number[]", + "optional": false, + "field": "color", + "description": "

RGB colour values

" + }, + { + "group": "200", + "type": "Number", + "optional": false, + "field": "createdAt", + "description": "

Group creation timestamp in milliseconds

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "description", + "description": "

Group description

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "name", + "description": "

Group name

" + }, + { + "group": "200", + "type": "Object[]", + "optional": false, + "field": "objects", + "description": "

List of objects in group

" + }, + { + "group": "200", + "type": "Object[]", + "optional": false, + "field": "rules", + "description": "

List of rules in group

" + }, + { + "group": "200", + "type": "Number[]", + "optional": false, + "field": "transformation", + "description": "

Flat 16 element array representation of 4x4 transformation matrix

" + }, + { + "group": "200", + "type": "Number", + "optional": false, + "field": "updatedAt", + "description": "

Group update timestamp in milliseconds

" + }, + { + "group": "200", + "type": "Number", + "optional": false, + "field": "updatedBy", + "description": "

Username of last user to amend group

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "_id", + "description": "

Unique ID of group

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/group.js", + "groupTitle": "Groups", + "groupDescription": "

A grouping of model elements. Groups can either comprise of a set of manually defined elements or rules (smart group) that define the criteria for its elements.

" + }, + { + "type": "post", + "url": "/:teamspace/:model/groups/import", + "title": "Import Groups", + "name": "importGroups", + "group": "Groups", + "description": "

This is a back-ported endpoint from V5. For details please see V5 documentation /docs/#/Federations/ImportFederationGroups

", + "version": "0.0.0", + "filename": "src/v4/routes/group.js", + "groupTitle": "Groups", + "groupDescription": "

A grouping of model elements. Groups can either comprise of a set of manually defined elements or rules (smart group) that define the criteria for its elements.

" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision(/master/head/|/:revId)/groups?[query]", + "title": "List all groups", + "name": "listGroups", + "group": "Groups", + "description": "

List all groups associated with the model.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "revId", + "description": "

Revision unique ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "ifcguids", + "description": "

Flag that returns IFC GUIDs for group elements

" + }, + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "noIssues", + "description": "

Flag that hides groups for issues

" + }, + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "noRisks", + "description": "

Flag that hides groups for risks

" + }, + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "noViews", + "description": "

Flag that hides groups for risks

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "updatedSince", + "description": "

Only return issues that has been updated since this value (in epoch value)

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "Object[]", + "optional": false, + "field": "objects", + "description": "

List of group objects

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"author\":\"alice\",\n\t\t\"color\":[255,0,0],\n\t\t\"createdAt\":1520592300000,\n\t\t\"description\":\"This is the description text for the first group.\",\n\t\t\"name\":\"Group 1\",\n\t\t\"objects\":[\n\t\t\t{\n\t\t\t\t\"account\": \"acme\",\n\t\t\t\t\"model\": \"00000000-0000-0000-0000-000000000000\",\n\t\t\t\t\"ifc_guids\": [],\n\t\t\t\t\"shared_ids\": [\n\t\t\t\t\t\"24fdcf2d-b9eb-4fa2-a614-dfe2532493b3\",\n\t\t\t\t\t\"db18ef69-6d6e-49a0-846e-907346abb39d\",\n\t\t\t\t\t\"c532ff34-6669-4807-b7f3-6a0ffb17b027\",\n\t\t\t\t\t\"fec16ea6-bb7b-4f12-b39b-f06fe6bf041d\",\n\t\t\t\t\t\"3f881fa8-2b7b-443e-920f-396c1c85e903\"\n\t\t\t\t]\n\t\t\t}\n\t\t],\n\t\t\"updatedAt\":1552128300000,\n\t\t\"updatedBy\":\"alice\",\n\t\t\"_id\":\"00000000-0000-0000-0000-000000000002\"\n\t},\n\t{\n\t\t\"author\":\"alice\",\n\t\t\"color\":[0,255,0],\n\t\t\"createdAt\":1520592300000,\n\t\t\"description\":\"(No description)\",\n\t\t\"name\":\"Group 2\",\n\t\t\"objects\":[\n\t\t\t{\n\t\t\t\t\"account\": \"acme\",\n\t\t\t\t\"model\": \"00000000-0000-0000-0000-000000000000\",\n\t\t\t\t\"ifc_guids\": [],\n\t\t\t\t\"shared_ids\": [\n\t\t\t\t\t\"c532ff34-6669-4807-b7f3-6a0ffb17b027\",\n\t\t\t\t\t\"fec16ea6-bb7b-4f12-b39b-f06fe6bf041d\"\n\t\t\t\t]\n\t\t\t}\n\t\t],\n\t\t\"rules\":[],\n\t\t\"updatedAt\":1552128300000,\n\t\t\"updatedBy\":\"alice\",\n\t\t\"_id\":\"00000000-0000-0000-0000-000000000003\"\n\t}\n]", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage (/master/head)", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/revision/master/head/groups HTTP/1.1", + "type": "get" + }, + { + "title": "Example usage (/:revId)", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/revision/00000000-0000-0000-0000-000000000001/groups HTTP/1.1", + "type": "get" + }, + { + "title": "Example usage (no issue/risk groups)", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/revision/master/head/groups?noIssues=true&noRisks=true HTTP/1.1", + "type": "get" + }, + { + "title": "Example usage (with IFC GUIDs)", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/revision/master/head/groups?ifcguids=true HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/group.js", + "groupTitle": "Groups", + "groupDescription": "

A grouping of model elements. Groups can either comprise of a set of manually defined elements or rules (smart group) that define the criteria for its elements.

" + }, + { + "type": "put", + "url": "/:teamspace/:model/revision(/master/head|/:revId)/groups/:groupId/", + "title": "Update group", + "name": "updateGroup", + "group": "Groups", + "description": "

Update a group.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "revId", + "description": "

Revision ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "groupId", + "description": "

Group ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "author", + "description": "

Username of group creator

" + }, + { + "group": "Request body", + "type": "Number[]", + "optional": false, + "field": "color", + "description": "

RGB colour values

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "description", + "description": "

Group description

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "name", + "description": "

Group name

" + }, + { + "group": "Request body", + "type": "Object[]", + "optional": false, + "field": "objects", + "description": "

List of objects in group

" + }, + { + "group": "Request body", + "type": "Object[]", + "optional": true, + "field": "rules", + "description": "

List of rules in group

" + }, + { + "group": "Request body", + "type": "Number[]", + "optional": true, + "field": "transformation", + "description": "

Flat 16 element array representation of 4x4 transformation matrix

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage (/master/head)", + "content": "PUT /acme/00000000-0000-0000-0000-000000000000/revision/master/head/groups/00000000-0000-0000-0000-000000000002 HTTP/1.1", + "type": "put" + }, + { + "title": "Example usage (/:revId)", + "content": "PUT /acme/00000000-0000-0000-0000-000000000000/revision/00000000-0000-0000-0000-000000000001/groups/00000000-0000-0000-0000-000000000002 HTTP/1.1", + "type": "put" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"author\":\"alice\",\n\t\"color\":[255,0,0],\n\t\"createdAt\":1520592300000,\n\t\"description\":\"Updated description text.\",\n\t\"name\":\"Group 1\",\n\t\"objects\":[\n\t\t{\n\t\t\t\"account\": \"acme\",\n\t\t\t\"model\": \"00000000-0000-0000-0000-000000000000\",\n\t\t\t\"ifc_guids\": [],\n\t\t\t\"shared_ids\": [\n\t\t\t\t\"db18ef69-6d6e-49a0-846e-907346abb39d\",\n\t\t\t\t\"c532ff34-6669-4807-b7f3-6a0ffb17b027\",\n\t\t\t\t\"fec16ea6-bb7b-4f12-b39b-f06fe6bf041d\",\n\t\t\t\t\"3f881fa8-2b7b-443e-920f-396c1c85e903\"\n\t\t\t]\n\t\t}\n\t],\n\t\"updatedAt\":1552128300000,\n\t\"updatedBy\":\"alice\",\n\t\"_id\":\"00000000-0000-0000-0000-000000000002\"\n}", + "type": "json" + } + ], + "fields": { + "200": [ + { + "group": "200", + "type": "String", + "optional": false, + "field": "author", + "description": "

Username of group creator

" + }, + { + "group": "200", + "type": "Number[]", + "optional": false, + "field": "color", + "description": "

RGB colour values

" + }, + { + "group": "200", + "type": "Number", + "optional": false, + "field": "createdAt", + "description": "

Group creation timestamp in milliseconds

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "description", + "description": "

Group description

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "name", + "description": "

Group name

" + }, + { + "group": "200", + "type": "Object[]", + "optional": false, + "field": "objects", + "description": "

List of objects in group

" + }, + { + "group": "200", + "type": "Object[]", + "optional": false, + "field": "rules", + "description": "

List of rules in group

" + }, + { + "group": "200", + "type": "Number[]", + "optional": false, + "field": "transformation", + "description": "

Flat 16 element array representation of 4x4 transformation matrix

" + }, + { + "group": "200", + "type": "Number", + "optional": false, + "field": "updatedAt", + "description": "

Group update timestamp in milliseconds

" + }, + { + "group": "200", + "type": "Number", + "optional": false, + "field": "updatedBy", + "description": "

Username of last user to amend group

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "_id", + "description": "

Unique ID of group

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/group.js", + "groupTitle": "Groups", + "groupDescription": "

A grouping of model elements. Groups can either comprise of a set of manually defined elements or rules (smart group) that define the criteria for its elements.

" + }, + { + "type": "get", + "url": "/:teamspace/:model/revisions.json", + "title": "List all revisions", + "name": "listRevisions", + "group": "History", + "description": "

List all revisions for a model.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "Object", + "optional": false, + "field": "Revisions", + "description": "

object

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"_id\":\"00000000-0000-0000-0000-000000000001\",\n\t\t\"author\":\"alice\",\n\t\t\"timestamp\":\"2009-06-06T00:00:00.000Z\",\n\t\t\"name\":\"00000000-0000-0000-0000-000000000001\",\n\t\t\"branch\":\"master\"\n\t}\n]", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/revisions.json HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/history.js", + "groupTitle": "History" + }, + { + "type": "get", + "url": "/:teamspace/:model/revisions/:branch.json", + "title": "List all revisions by branch", + "name": "listRevisionsByBranch", + "group": "History", + "description": "

List all model revisions from a branch.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "branch", + "description": "

Name of revision branch

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "optional": false, + "field": "Revisions", + "description": "

object for a branch

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"_id\":\"00000000-0000-0000-0000-000000000004\",\n\t\t\"author\": \"alice\",\n\t\t\"desc\": \"For coordination\",\n\t\t\"timestamp\": \"2015-10-21T07:28:00.000Z\",\n\t\t\"name\":\"00000000-0000-0000-0000-000000000004\",\n\t\t\"branch\": \"staging\"\n\t},\n\t{\n\t\t\"_id\":\"00000000-0000-0000-0000-000000000003\",\n\t\t\"author\": \"alice\",\n\t\t\"desc\": \"Roof access added\",\n\t\t\"timestamp\": \"1985-10-26T09:00:00.000Z\",\n\t\t\"name\":\"00000000-0000-0000-0000-000000000003\",\n\t\t\"branch\": \"staging\"\n\t},\n\t{\n\t\t\"_id\":\"00000000-0000-0000-0000-000000000002\",\n\t\t\"author\": \"alice\",\n\t\t\"desc\": \"Initial design\",\n\t\t\"timestamp\": \"1955-11-12T06:38:00.000Z\",\n\t\t\"name\":\"00000000-0000-0000-0000-000000000002\",\n\t\t\"branch\": \"staging\"\n\t}\n]", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/revisions/staging.json HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/history.js", + "groupTitle": "History" + }, + { + "type": "patch", + "url": "/:teamspace/:model/revisions/:id", + "title": "Update revision status", + "name": "updateRevisionStatus", + "group": "History", + "description": "

Update the status of revision, setting it to void/active

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "id", + "description": "

Unique Revision ID or tag

" + } + ] + }, + "examples": [ + { + "title": "Input", + "content": "{\n \"void\": true\n}", + "type": "json" + } + ] + }, + "success": { + "examples": [ + { + "title": "Success", + "content": "HTTP/1.1 200 OK\n{}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/history.js", + "groupTitle": "History" + }, + { + "type": "post", + "url": "/:teamspace/invitations", + "title": "Create/Update invitation", + "name": "createInvitation", + "group": "Invitations", + "description": "

It creates or updates an invitation with the permissions and a job assigned to the invited email

", + "permission": [ + { + "name": "teamSpaceAdmin" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "email", + "description": "

The email to which the invitation will be sent

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "job", + "description": "

An existing job for the teamspace

" + }, + { + "group": "Request body", + "type": "Permissions", + "optional": false, + "field": "permissions", + "description": "

Valid permissions for the invited. If there is a teamspace_admin: true the rest of the permissions for that teamspace are ignored.

" + } + ], + "Request body: Permisssions": [ + { + "group": "Request body: Permisssions", + "type": "Boolean", + "optional": true, + "field": "teamspace_admin", + "description": "

Flag indicating if the invited user will become a teamspace administrator. If this flag is true the rest of the permissions are ignored.

" + }, + { + "group": "Request body: Permisssions", + "type": "ProjectPermissions[]", + "optional": true, + "field": "projects", + "description": "

Permissions for projects and their models.

" + } + ], + "Request body: ProjectPermissions": [ + { + "group": "Request body: ProjectPermissions", + "type": "String", + "optional": false, + "field": "project", + "description": "

The id of the project in which the project permissions will be applied for the invited user.

" + }, + { + "group": "Request body: ProjectPermissions", + "type": "Boolean", + "optional": true, + "field": "project_admin", + "description": "

Flag indicating if the invited user will become a teamspace administrator. If this flag is true the rest of the permissions are ignored.

" + }, + { + "group": "Request body: ProjectPermissions", + "type": "ModelPermissions[]", + "optional": true, + "field": "models", + "description": "

An array indicating the permissions for the models.

" + } + ], + "Request body: ModelPermissions": [ + { + "group": "Request body: ModelPermissions", + "type": "String", + "optional": false, + "field": "model", + "description": "

The id of the model that will have the permission applied for the invited user.

" + }, + { + "group": "Request body: ModelPermissions", + "type": "String", + "optional": false, + "field": "permission", + "description": "

The type of permission applied for the invited user. Valid values are 'viewer', 'commenter' or 'collaborator'

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage (with projects and models, permissions):", + "content": "POST /teamSpace1/invitations HTTP/1.1\n\t{\n\t\temail:'invited@enterprise.com'\n\t\tjob: 'jobA',\n\t\tpermissions:{\n\t\t\tprojects:[\n\t\t\t\t{\n\t\t\t\t\tproject: '5bf7df65-f3a8-4337-8016-a63f00000000',\n\t\t\t\t\tmodels: [\n\t\t\t\t\t\t{ model: '5bfc11fa-50ac-b7e7-4328-83aa11fa50ac', permission:'viewer'},\n\t\t\t\t\t\t{ model: '00b1fb4d-091d-4f11-8dd6-9deaf71f5ca5', permission:'commenter'},\n\t\t\t\t\t]\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tproject: 'Bim Logo',\n\t\t\t\t\tproject_admin: true\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}", + "type": "post" + }, + { + "title": "Example usage (with teamspace admin):", + "content": "POST /teamSpace1/invitations HTTP/1.1\n\t{\n\t\temail:'anotherinvited@enterprise.com'\n\t\tjob: 'jobA',\n\t\tpermissions: {\n\t\t\tteamspace_admin: true\n\t\t}\n\t}", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success (with projects and models, permissions)", + "content": "HTTP/1.1 200 OK\n\t{\n\t\temail:'invited@enterprise.com'\n\t\tjob: 'jobA',\n\t\tpermissions:{\n\t\t\tprojects:[\n\t\t\t\t{\n\t\t\t\t\tproject: '5bf7df65-f3a8-4337-8016-a63f00000000',\n\t\t\t\t\tmodels: [\n\t\t\t\t\t\t{ model: '5bfc11fa-50ac-b7e7-4328-83aa11fa50ac', permission:'viewer'},\n\t\t\t\t\t\t{ model: '00b1fb4d-091d-4f11-8dd6-9deaf71f5ca5', permission:'commenter'},\n\t\t\t\t\t]\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tproject: 'Bim Logo',\n\t\t\t\t\tproject_admin: true\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}", + "type": "json" + }, + { + "title": "Success (with teamspace admin)", + "content": "HTTP/1.1 200 OK\n\t{\n\t\temail:'anotherinvited@enterprise.com'\n\t\tjob: 'jobA',\n\t\tpermissions: {\n\t\t\tteamspace_admin: true\n\t\t}\n\t}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/invitations.js", + "groupTitle": "Invitations" + }, + { + "type": "get", + "url": "/:teamspace/invitations", + "title": "Get invitations list", + "name": "getInvitations", + "group": "Invitations", + "description": "

It returns a list of invitations with their permissions and their jobs.

", + "permission": [ + { + "name": "teamSpaceAdmin" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/invitations HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success", + "content": "HTTP/1.1 200 OK\n[\n {\n \"email\": \"7e634bae01db4f@mail.com\",\n \"job\": \"jobA\",\n \"permissions\": {\n \"teamspace_admin\": true\n }\n },\n {\n \"email\": \"93393d28f953@mail.com\",\n \"job\": \"jobA\",\n \"permissions\": {\n \"projects\": [\n {\n \"project\": '5bf7df65-f3a8-4337-8016-a63f00000000',\n \"project_admin\": true\n }\n ]\n }\n },\n {\n \"email\": \"48bc8da2f3bc@mail.com\",\n \"job\": \"jobA\",\n \"permissions\": {\n \"projects\": [\n {\n \"project\": '5bf7df65-f3a8-4337-8016-a63f00000000',\n \"models\": [\n {\n \"model\": \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\",\n \"permission\": \"collaborator\"\n }\n ]\n }\n ]\n }\n }\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/invitations.js", + "groupTitle": "Invitations" + }, + { + "type": "delete", + "url": "/:teamspace/invitations/:email", + "title": "Revokes an invitation", + "name": "removeInvitation", + "group": "Invitations", + "description": "

It revokes an invitation for a teamspace

", + "permission": [ + { + "name": "teamSpaceAdmin" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "email", + "description": "

Email of the user invitation that you wish to revoke

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "DELETE /teamSpace1/invitations/invited@enterprise.com HTTP/1.1", + "type": "delete" + } + ], + "success": { + "examples": [ + { + "title": "Success", + "content": "HTTP/1.1 200 OK\n{}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/invitations.js", + "groupTitle": "Invitations" + }, + { + "type": "get", + "url": "/:teamspace/invoices", + "title": "List all invoices", + "name": "listInvoices", + "group": "Invoice", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "description": "

List all invoices if available, to current logged in user.

", + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "Object", + "optional": false, + "field": "Invoice", + "description": "

Object

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\"_id\":\"invoice_ID\",\n\t\"invoiceNo\":\"AA-111\",\n\t\"nextPaymentAmount\":00,\n\t\"taxAmount\":0,\n\t\"amount\":00,\n\t\"currency\":\"GBP\",\n\t\"transactionId\":\"transaction_ID\",\n\t\"gateway\":\"GATEWAY_PROVIDER\",\n\t\"billingAgreementId\":\"billing_agreement_ID\",\n\t\"periodEnd\":\"2018-06-03\",\n\t\"periodStart\":\"2018-05-04\",\n\t \"info\":\n\t\t{\n\t\t \"vat\":\"\",\n\t\t \"countryCode\":\"AO\",\n\t\t \"postalCode\":\"SW11 1BQ\",\n\t\t \"city\":\"London\",\n\t\t \"line2\":\"1 Street Road\",\n\t\t \"line1\":\"London\",\n\t\t \"company\":\"Comapny\",\n\t\t \"lastName\":\"User Lastname\",\n\t\t \"firstName\":\"User Firstname\",\n\t\t \"_id\":\"invoice_ID\",\n\t\t \"countryName\":\"United Kingdom\"\n\t\t},\n\t \"nextPaymentDate\":\"2018-06-04\",\n\t \"createdAt\":\"04-05-2018 15:59\",\n\t \"__v\":0,\"state\":\"complete\",\n\t \"items\":\n\t\t[{\n\t\t\t \"name\":\"pricingPlanName\",\n\t\t\t\"currency\":\"GBP\",\n\t\t\t\"amount\":00,\n\t\t\t\"taxAmount\":0,\n\t\t\t\"_id\":\"invoice_ID\",\n\t\t\t\"description\":\"Advance License (from 2018)\",\n\t\t\t\"id\":\"invoice_ID\"},\n\t\t\t {\n\t\t\t\t\"name\":\"pricingPlanName\",\n\t\t\t\t\"currency\":\"GBP\",\n\t\t\t\t\"amount\":29,\n\t\t\t\t\"taxAmount\":0,\n\t\t\t\t\"_id\":\"invoice_ID\",\n\t\t\t\t\"description\":\"This is a dummy invoice for use with API Documentation\",\n\t\t\t\t\"id\":\"invoice_ID\"\n\t\t}],\n\t\t\t\t\"type\":\"invoice\",\n\t\t\t\t\"proRata\":false,\n\t\t\t\t\"pending\":false,\n\t\t\t\t\"unitPrice\":\"29.00\",\n\t\t\t\t\"B2B_EU\":false,\n\t\t\t\t\"taxPercentage\":0,\n\t\t\t\t\"createdAtDate\":\"2018-05-04\",\n\t\t\t\t\"netAmount\":00\n\t}\n]", + "type": "json" + } + ] + }, + "error": { + "fields": { + "401": [ + { + "group": "401", + "optional": false, + "field": "NOT_AUTHORIZED", + "description": "

Not Authorized

" + } + ] + }, + "examples": [ + { + "title": "Error-Response", + "content": "\nHTTP/1.1 401 Not Authorized\n{\n\t\"message\":\"Not Authorized\",\n\t\"status\":401,\"code\":\n\t\"NOT_AUTHORIZED\",\n\t\"value\":9,\n\t\"place\":\"GET /nabile/subscriptions\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/invoice.js", + "groupTitle": "Invoice" + }, + { + "type": "get", + "url": "/:teamspace/invoices/:invoiceNo.html", + "title": "Render invoices as HTML", + "name": "renderInvoice", + "group": "Invoice", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "invoiceNo", + "description": "

Invoice number to render.

" + } + ] + } + }, + "description": "

Render a HTML web page of the requested invoice.

", + "version": "0.0.0", + "filename": "src/v4/routes/invoice.js", + "groupTitle": "Invoice" + }, + { + "type": "get", + "url": "/:teamspace/invoices/:invoiceNo.pdf", + "title": "Render invoices as PDF", + "name": "renderInvoicePDF", + "group": "Invoice", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "optional": false, + "field": "invoiceNo.pdf", + "description": "

Invoice to render.

" + } + ] + } + }, + "description": "

Render out a PDF version of the requested invocie.

", + "version": "0.0.0", + "filename": "src/v4/routes/invoice.js", + "groupTitle": "Invoice" + }, + { + "type": "post", + "url": "/:teamspace/:model/issues/:issueId/resources", + "title": "Attach resources to an issue", + "name": "attachResource", + "group": "Issues", + "description": "

Attaches file or url resources to an issue. If the type of the resource is file it should be send as multipart/form-data. Both types at the same time cant be sent. So in order to attach files and urls it should be done with two different requests.

This method triggers a chat event

", + "parameter": { + "fields": { + "Request body file resource (multipart/form-data)": [ + { + "group": "Request body file resource (multipart/form-data)", + "type": "File[]", + "optional": false, + "field": "files", + "description": "

The array of files to be attached

" + }, + { + "group": "Request body file resource (multipart/form-data)", + "type": "String[]", + "optional": false, + "field": "names", + "description": "

The names of the files; it should have the same length as the files field and should include the file extension

" + } + ], + "Request body url resource": [ + { + "group": "Request body url resource", + "type": "String[]", + "optional": false, + "field": "urls", + "description": "

The array of urls to be attached

" + }, + { + "group": "Request body url resource", + "type": "String[]", + "optional": false, + "field": "names", + "description": "

The names of the urls; it should have the same length as the url field

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "issueId", + "description": "

Issue ID

" + } + ] + } + }, + "success": { + "examples": [ + { + "title": "Success example result after two files has been uploaded", + "content": "\n[\n {\n \"_id\":\"7617f775-9eb7-4877-8ec3-98ea3457e519\",\n \"size\":1422,\n \"issueIds\":[\n \"3e8a11e0-9812-11e9-9c4d-ebde5888e062\"\n ],\n \"name\":\"todo.txt\",\n \"user\":\"teamSpace1\",\n \"createdAt\":1561973996461\n },\n {\n \"_id\":\"e25e42d5-c4f0-4fbc-a8f4-bc9899e6662a\",\n \"size\":2509356,\n \"issueIds\":[\n \"3e8a11e0-9812-11e9-9c4d-ebde5888e062\"\n ],\n \"name\":\"football.gif\",\n \"user\":\"teamSpace1\",\n \"createdAt\":1561973996462\n }\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues" + }, + { + "type": "post", + "url": "/:teamspace/:model/issues/:issueId/comments", + "title": "Add comment to issue", + "name": "commentIssue", + "group": "Issues", + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "comment", + "description": "

Comment text

" + }, + { + "group": "Request body", + "type": "Viewpoint", + "optional": true, + "field": "viewpoint", + "description": "

The viewpoint associated with the comment

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "issueId", + "description": "

Issue ID

" + } + ], + "Type: Viewpoint": [ + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "right", + "description": "

Right vector of viewpoint indicating the direction of right in relative coordinates

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "up", + "description": "

Up vector of viewpoint indicating the direction of up in relative coordinates

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "position", + "description": "

Position vector indicates where in the world the viewpoint is positioned

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "look_at", + "description": "

Vector indicating where in the world the viewpoint is looking at

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "view_dir", + "description": "

Vector indicating the direction the viewpoint is looking at in relative coordinates

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "near", + "description": "

Vector indicating the near plane

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "far", + "description": "

Vector indicating the far plane

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "fov", + "description": "

Angle of the field of view

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "aspect_ratio", + "description": "

Aspect ratio of the fustrum

" + }, + { + "group": "Type: Viewpoint", + "type": "ClippingPlane[]", + "optional": true, + "field": "clippingPlanes", + "description": "

Clipping planes associated with the viewpoint

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": true, + "field": "highlighted_group_id", + "description": "

If the viewpoint is associated with one or more highlighted objects from the model this field has the value of a group ID generated to hold those objects

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": true, + "field": "hidden_group_id", + "description": "

If the viewpoint is associated with one or more hidden objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": true, + "field": "shown_group_id", + "description": "

If the viewpoint is associated with one or more shown objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: Viewpoint", + "type": "Group", + "optional": true, + "field": "highlighted_group", + "description": "

If the viewpoint is associated with one or more highlighted objects from the model this field has the value of a group definition for those objects (this shouldnt be use simultaneously with highlighted_group_id)

" + }, + { + "group": "Type: Viewpoint", + "type": "Group", + "optional": true, + "field": "hidden_group", + "description": "

If the viewpoint is associated with one or more hidden objects from the model this field has the value of a group id generated to hold those objects (this shouldnt be use simultaneously with hidden_group_id)

" + }, + { + "group": "Type: Viewpoint", + "type": "Group", + "optional": true, + "field": "shown_group", + "description": "

If the viewpoint is associated with one or more shown objects from the model this field has the definition of the group to hold those objects (this shouldnt be use simultaneously with shown_group_id)

" + }, + { + "group": "Type: Viewpoint", + "type": "Group[]", + "optional": true, + "field": "override_groups", + "description": "

If the viewpoint has one or more objects with colour override this field has an array of groups with one group for each colour

" + }, + { + "group": "Type: Viewpoint", + "type": "Group[]", + "optional": true, + "field": "transformation_groups", + "description": "

List of groups with transformations

" + }, + { + "group": "Type: Viewpoint", + "type": "String[]", + "optional": true, + "field": "transformation_group_ids", + "description": "

List of group IDs with transformations

" + }, + { + "group": "Type: Viewpoint", + "type": "Boolean", + "optional": false, + "field": "hide_IFC", + "description": "

A flag to hide the IFC

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": false, + "field": "screenshot", + "description": "

Base64 string representing the screenshot associated with the viewpoint

" + } + ], + "Type: Group": [ + { + "group": "Type: Group", + "type": "Number[3]", + "optional": false, + "field": "color", + "description": "

RGB colour values

" + }, + { + "group": "Type: Group", + "type": "ModelObjects", + "optional": false, + "field": "objects", + "description": "

List of objects in group

" + } + ], + "Type: ModelObjects": [ + { + "group": "Type: ModelObjects", + "type": "String", + "optional": false, + "field": "account", + "description": "

The account that has the model which contains the objects

" + }, + { + "group": "Type: ModelObjects", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model id that contains the objects

" + }, + { + "group": "Type: ModelObjects", + "type": "String[]", + "optional": false, + "field": "shared_ids", + "description": "

The shared ids of objects to be selected

" + } + ], + "Type: ClippingPlane": [ + { + "group": "Type: ClippingPlane", + "type": "Number[3]", + "optional": false, + "field": "normal", + "description": "

The normal of the plane defined for the clipping plane

" + }, + { + "group": "Type: ClippingPlane", + "type": "Number", + "optional": false, + "field": "distance", + "description": "

The distance for the clipping plane to the origin

" + }, + { + "group": "Type: ClippingPlane", + "type": "Number", + "optional": false, + "field": "clipDirection", + "description": "

The direction to the clipping plane will cut the model; above or below the plane. Possible values: 1 , -1.

" + } + ] + }, + "examples": [ + { + "title": "PAYLOAD", + "content": "{\n \"comment\": \"This is a commment\",\n \"viewpoint\": {right: [-0.0374530553817749, -7.450580596923828e-9, -0.9992983341217041],…}\n}", + "type": "json" + } + ] + }, + "success": { + "examples": [ + { + "title": "Success", + "content": " HTTP/1.1 200 OK\n{\n guid: \"096de7ed-e3bb-4d5b-ae68-17a5cf7a5e5e\",\n comment: \"This is a commment\",\n created: 1558534690327,\n guid: \"096de7ed-e3bb-4d5b-ae68-17a5cf7a5e5e\",\n owner: \"username\",\n viewpoint: {right: [-0.0374530553817749, -7.450580596923828e-9, -0.9992983341217041],…}\n}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "Error 4xx": [ + { + "group": "Error 4xx", + "optional": false, + "field": "404", + "description": "

Issue not found

" + }, + { + "group": "Error 4xx", + "optional": false, + "field": "400", + "description": "

Comment with no text

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues" + }, + { + "type": "delete", + "url": "/:teamspace/:model/issues/:issueId/comments", + "title": "Deletes an comment from an issue", + "name": "commentIssue", + "group": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Json", + "optional": false, + "field": "PAYLOAD", + "description": "

The data with the comment guid to be deleted.

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "issueId", + "description": "

Issue ID

" + } + ] + }, + "examples": [ + { + "title": "PAYLOAD", + "content": "{\n guid: \"096de7ed-e3bb-4d5b-ae68-17a5cf7a5e5e\"\n}", + "type": "json" + } + ] + }, + "success": { + "examples": [ + { + "title": "Success", + "content": " HTTP/1.1 200 OK\n{\n guid: \"096de7ed-e3bb-4d5b-ae68-17a5cf7a5e5e\"\n}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "Error 4xx": [ + { + "group": "Error 4xx", + "optional": false, + "field": "404", + "description": "

Issue not found

" + }, + { + "group": "Error 4xx", + "optional": false, + "field": "401", + "description": "

Not authorized, when the user is not the owner

" + }, + { + "group": "Error 4xx", + "optional": false, + "field": "400", + "description": "

Issue comment sealed, when the user is trying to delete a comment that is sealed

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues" + }, + { + "type": "delete", + "url": "/:teamspace/:model/issues/:issueId/resources", + "title": "Detach a resource from an issue", + "name": "detachResource", + "group": "Issues", + "description": "

Detachs a resource from an issue. If the issue is the last entity the resources has been attached to it also deletes the resource from the system. This method triggers a chat event .

", + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "_id", + "description": "

The resource id to be detached

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "issueId", + "description": "

Issue ID

" + } + ] + } + }, + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n \"_id\":\"e25e42d5-c4f0-4fbc-a8f4-bc9899e6662a\",\n \"size\":2509356,\n \"issueIds\":[\n ],\n \"name\":\"football.gif\",\n \"user\":\"teamSpace1\",\n \"createdAt\":1561973996462\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues" + }, + { + "type": "get", + "url": "/:teamspace/:model/issues/:issueId", + "title": "Get issue", + "name": "findIssue", + "group": "Issues", + "description": "

Find an issue with the requested Issue ID.

", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "issue", + "description": "

The Issue matching the Issue ID

" + } + ] + }, + "examples": [ + { + "title": "Success-Response.", + "content": "HTTP/1.1 200 OK\n{\n\t\taccount: \"username\"\n\t\tassigned_roles: []\n\t\tcommentCount: 0\n\t\tcreated: 1542723030489\n\t\tcreator_role: \"3D Repo\"\n\t\tdesc: \"(No Description)\"\n\t\tmodel: \"model_ID\"\n\t\tmodelCode: \"\"\n\t\tname: \"Issue one\"\n\t\tnumber: 1\n\t\towner: \"username\"\n\t\tposition: []\n\t\tpriority: \"none\"\n\t\trev_id: \"revision_ID\"\n\t\tscale: 1\n\t\tstatus: \"open\"\n\t\tthumbnail: \"USERNAME/MODEL_ID/issues/ISSUE_ID/thumbnail.png\"\n\t\ttopic_type: \"for_information\"\n\t\ttypePrefix: \"Architectural\"\n\t\tviewCount: 1\n\t\tviewpoint: {near: 24.057758331298828, far: 12028.87890625, fov: 1.0471975803375244,…}\n\t\t__v: 0\n\t\t_id: \"ISSUE_ID\"\n}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "Error 4xx": [ + { + "group": "Error 4xx", + "optional": false, + "field": "ISSUE_NOT_FOUND", + "description": "

Issue not found

" + } + ] + }, + "examples": [ + { + "title": "HTTP/1.1 404 Not Found", + "content": "HTTP/1.1 404 Not Found\n{\n\t \"place\": \"GET /issues/:issueId\",\n\t \"status\": 500,\n\t \"message\": \"Issue not found\",\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "issueId", + "description": "

Issue ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/issues.bcfzip", + "title": "Download issues BCF file", + "name": "getIssuesBCF", + "group": "Issues", + "description": "

Download issues as a BCF file.

", + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:revId/issues.bcfzip", + "title": "Get Issues BCF zip file by revision ID", + "name": "getIssuesBCFTRid", + "group": "Issues", + "description": "

Get Issues BCF export based on revision ID.

", + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "revId", + "description": "

Revision ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/issues/:issueId/viewpoints/:viewpointId/screenshot.png", + "title": "Get issue viewpoint screenshot", + "name": "getScreenshot", + "group": "Issues", + "description": "

Get an issue viewpoint screenshot.

", + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "issueId", + "description": "

Issue ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "viewpointId", + "description": "

Viewpoint ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/issues/:issueId/viewpoints/:viewpointId/screenshotSmall.png", + "title": "Get smaller version of Issue screenshot", + "name": "getScreenshotSmall", + "group": "Issues", + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "Object", + "optional": false, + "field": "Issue", + "description": "

Screenshot.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "issueId", + "description": "

Issue ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "viewpointId", + "description": "

Viewpoint ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/issues/:issueId/thumbnail.png", + "title": "Get issue thumbnail", + "name": "getThumbnail", + "group": "Issues", + "description": "

Retrieve screenshot thumbnail image for requested issue.

", + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "Object", + "optional": false, + "field": "thumbnail", + "description": "

Thumbnail image

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "issueId", + "description": "

Issue ID

" + } + ] + } + } + }, + { + "type": "post", + "url": "/:teamspace/:model/issues.bcfzip", + "title": "Import BCF file", + "name": "importBCF", + "group": "Issues", + "description": "

Upload issues BCF file.

", + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/issues?[query]", + "title": "List Issues", + "name": "listIssues", + "group": "Issues", + "description": "

List all issues for model.

", + "success": { + "examples": [ + { + "title": "Success-Response.", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"_id\":\"ISSUE_ID\",\n\t\t\"creator_role\":\"Client\",\"scale\":1,\n\t\t\"due_date\":1543881600000,\n\t\t\"priority\":\"low\",\n\t\t\"desc\":\"reverse\",\n\t\t\"topic_type\":\"for_information\",\n\t\t\"status\":\"for approval\",\n\t\t\"owner\":\"username\",\n\t\t\"created\":1546217360002,\n\t\t\"name\":\"Without reverse\",\n\t\t\"number\":2,\n\t\t\"rev_id\":\"REVISION_ID\",\n\t\t\"__v\":0,\n\t\t\"assigned_roles\":[\"Architect\"],\n\t\t\"viewCount\":1,\n\t\t\"commentCount\":0,\n\t\t\"thumbnail\":\"nabile/MODEL_ID/issues/ISSUE_ID/thumbnail.png\",\n\t\t\"position\":[8341.8056640625,1279.962158203125,-3050.34521484375],\n\t\t\"typePrefix\":\"sample\",\n\t\t\"modelCode\":\"\",\n\t\t\"account\":\"username\",\n\t\t\"model\":\"MODEL_ID\",\n\t\t\"viewpoint\":\n\t\t\t{\n\t\t\t\t\"near\":54.739341735839844,\n\t\t\t\t\"far\":27369.669921875,\n\t\t\t\t\"fov\":1.0471975803375244,\n\t\t\t\t\"aspect_ratio\":1.451704502105713,\n\t\t\t\t\"hideIfc\":true,\n\t\t\t\t\"guid\":\"9279d95e-3aee-49c2-ba45-9d2302044597\",\n\t\t\t\t\"_id\":\"5c296790e5f57704580ca00a\",\n\t\t\t\t\"type\":\"perspective\",\n\t\t\t\t\"screenshot\":\"ACCOUNT/MODEL_ID/issues/ISSUE_ID/viewpoints/MODEL_ID/screenshot.png\",\n\t\t\t\t\"clippingPlanes\":[],\"right\":[0.7270411252975464,1.862645149230957e-8,0.6865938901901245],\n\t\t\t\t\"view_dir\":[0.6777805089950562,-0.15971262753009796,-0.7177084684371948],\n\t\t\t\t\"look_at\":[8400.001953125,2339.99951171875,-9599.9990234375],\n\t\t\t\t\"position\":[-3360.6259765625,5111.28125,2853.4453125],\n\t\t\t\t\"up\":[0.10965770483016968,0.9871635437011719,-0.11611767113208771],\n\t\t\t\t\"screenshotSmall\":\"nabile/MODEL_ID/issues/ISSUE_ID/viewpoints/MODEL_ID/screenshotSmall.png\"\n\t\t\t}\n\t}\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Query": [ + { + "group": "Query", + "type": "String", + "optional": true, + "field": "convertCoords", + "description": "

Convert coordinates to user space

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "updatedSince", + "description": "

Only return issues updated since this value (in epoch value)

" + }, + { + "group": "Query", + "type": "Number[]", + "optional": true, + "field": "numbers", + "description": "

Array of issue numbers to filter for

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "ids", + "description": "

Array of issue IDs to filter for

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "topicTypes", + "description": "

Array of topic types to filter

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "status", + "description": "

Array of status to filter

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "priorities", + "description": "

Array of priorities to filter

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "owners", + "description": "

Array of owners to filter

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "assignedRoles", + "description": "

Array of assigned roles to filter. For searching unassigned issues the one of the values should be 'Unassigned'.

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:revId/issues", + "title": "List Issues by revision ID", + "name": "listIssuesByRevision", + "group": "Issues", + "description": "

Get all issues related to specific revision ID.

", + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "Object", + "optional": false, + "field": "Issues", + "description": "

Object

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "\n[\n\t{\n\t\t\"_id\":\"issue_ID\",\n\t\t\"creator_role\":\"Client\",\n\t\t\"scale\":1,\n\t\t\"due_date\":1547424000000,\n\t\t\"priority\":\"low\",\n\t\t\"desc\":\"This is a description\",\n\t\t\"topic_type\":\"for_information\",\n\t\t\"status\":\"open\",\"owner\":\"username\",\n\t\t\"created\":1546626949432,\n\t\t\"name\":\"An Issue for API\",\n\t\t\"number\":3,\n\t\t\"rev_id\":\"9cf31c6e-37cc-4625-8cee-270cf731059e\",\n\t\t\"__v\":0,\n\t\t\"assigned_roles\":[\"Architect\"],\n\t\t\"viewCount\":1,\"commentCount\":0,\n\t\t\"thumbnail\":\"ACCOUNT/MODEL_ID/issues/ISSUE_ID/thumbnail.png\",\n\t\t\"position\":[],\n\t\t\"typePrefix\":\"sample\",\n\t\t\"modelCode\":\"\",\n\t\t\"account\":\"username\",\n\t\t\"model\":\"MODEL_ID\",\n\t\t\"viewpoint\":\n\t\t\t{\n\t\t\t\t\"near\":54.739341735839844,\n\t\t\t\t\"far\":27369.669921875,\n\t\t\t\t\"fov\":1.0471975803375244,\n\t\t\t\t\"aspect_ratio\":2.522167444229126,\n\t\t\t\t\"hideIfc\":true,\n\t\t\t\t\"guid\":\"5afbe23f-8307-42d0-ba77-f031922281ce\",\n\t\t\t\t\"_id\":\"5c2fa785b4af3c45f8f83c60\",\n\t\t\t\t\"type\":\"perspective\",\n\t\t\t\t\"screenshot\":\"username/MODEL_ID/issues/ISSUE_ID/viewpoints/5afbe23f-8307-42d0-ba77-f031922281ce/screenshot.png\",\n\t\t\t\t\"clippingPlanes\":[],\"right\":[0.7270411252975464,1.862645149230957e-8,0.6865938901901245],\n\t\t\t\t\t\"view_dir\":[0.6777805089950562,-0.15971262753009796,-0.7177084684371948],\n\t\t\t\t\t\"look_at\":[8400.001953125,2339.99951171875,-9599.9990234375],\n\t\t\t\t\t\"position\":[-3360.6259765625,5111.28125,2853.4453125],\n\t\t\t\t\t\"up\":[0.10965770483016968,0.9871635437011719,-0.11611767113208771],\n\t\t\t\t\t\"screenshotSmall\"username/MODEL_ID/issues/ISSUE_ID/viewpoints/5afbe23f-8307-42d0-ba77-f031922281ce/screenshot.png\"}\n\t}\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "revId", + "description": "

Revision ID

" + } + ], + "Query": [ + { + "group": "Query", + "type": "String", + "optional": true, + "field": "convertCoords", + "description": "

Convert coordinates to user space

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "updatedSince", + "description": "

Only return issues updated since this value (in epoch value)

" + }, + { + "group": "Query", + "type": "Number[]", + "optional": true, + "field": "numbers", + "description": "

Array of issue numbers to filter for

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "ids", + "description": "

Array of issue IDs to filter for

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "topicTypes", + "description": "

Array of topic types to filter

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "status", + "description": "

Array of status to filter

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "priorities", + "description": "

Array of priorities to filter

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "owners", + "description": "

Array of owners to filter

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "assignedRoles", + "description": "

Array of assigned roles to filter. For searching unassigned issues the one of the values should be 'Unassigned'.

" + } + ] + } + } + }, + { + "type": "post", + "url": "/:teamspace/:model/issues", + "title": "Create issue", + "name": "newIssue", + "group": "Issues", + "description": "

Creates a new issue.

", + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "name", + "description": "

The name of the issue

" + }, + { + "group": "Request body", + "type": "String[]", + "optional": false, + "field": "assigned_roles", + "description": "

The roles assigned to the issue. Even though its an array (this is for future support of multiple assigned jobs), currently it has one or none elements correspoing to the available jobs in the teamaspace.

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "status", + "description": "

The status of the issue. It can have a value of "open","in progress","for approval", "void" or "closed".

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "priority", + "description": "

The priority of the issue. It can have a value of "none", String"low", "medium" or "high".

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "topic_type", + "description": "

Type of the issue. It's value has to be one of the defined topic_types for the model. See here for more details.

" + }, + { + "group": "Request body", + "type": "Viewpoint", + "optional": false, + "field": "viewpoint", + "description": "

The viewpoint of the issue, defining the position of the camera and the screenshot for that position.

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "desc", + "description": "

The description of the created issue

" + }, + { + "group": "Request body", + "type": "Number[3]", + "optional": false, + "field": "position", + "description": "

The vector defining the pin of the issue. If the pin doesnt has an issue its an empty array.

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Type: Viewpoint": [ + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "right", + "description": "

Right vector of viewpoint indicating the direction of right in relative coordinates

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "up", + "description": "

Up vector of viewpoint indicating the direction of up in relative coordinates

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "position", + "description": "

Position vector indicates where in the world the viewpoint is positioned

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "look_at", + "description": "

Vector indicating where in the world the viewpoint is looking at

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "view_dir", + "description": "

Vector indicating the direction the viewpoint is looking at in relative coordinates

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "near", + "description": "

Vector indicating the near plane

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "far", + "description": "

Vector indicating the far plane

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "fov", + "description": "

Angle of the field of view

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "aspect_ratio", + "description": "

Aspect ratio of the fustrum

" + }, + { + "group": "Type: Viewpoint", + "type": "ClippingPlane[]", + "optional": true, + "field": "clippingPlanes", + "description": "

Clipping planes associated with the viewpoint

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": true, + "field": "highlighted_group_id", + "description": "

If the viewpoint is associated with one or more highlighted objects from the model this field has the value of a group ID generated to hold those objects

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": true, + "field": "hidden_group_id", + "description": "

If the viewpoint is associated with one or more hidden objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": true, + "field": "shown_group_id", + "description": "

If the viewpoint is associated with one or more shown objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: Viewpoint", + "type": "Group", + "optional": true, + "field": "highlighted_group", + "description": "

If the viewpoint is associated with one or more highlighted objects from the model this field has the value of a group definition for those objects (this shouldnt be use simultaneously with highlighted_group_id)

" + }, + { + "group": "Type: Viewpoint", + "type": "Group", + "optional": true, + "field": "hidden_group", + "description": "

If the viewpoint is associated with one or more hidden objects from the model this field has the value of a group id generated to hold those objects (this shouldnt be use simultaneously with hidden_group_id)

" + }, + { + "group": "Type: Viewpoint", + "type": "Group", + "optional": true, + "field": "shown_group", + "description": "

If the viewpoint is associated with one or more shown objects from the model this field has the definition of the group to hold those objects (this shouldnt be use simultaneously with shown_group_id)

" + }, + { + "group": "Type: Viewpoint", + "type": "Group[]", + "optional": true, + "field": "override_groups", + "description": "

If the viewpoint has one or more objects with colour override this field has an array of groups with one group for each colour

" + }, + { + "group": "Type: Viewpoint", + "type": "Group[]", + "optional": true, + "field": "transformation_groups", + "description": "

List of groups with transformations

" + }, + { + "group": "Type: Viewpoint", + "type": "String[]", + "optional": true, + "field": "transformation_group_ids", + "description": "

List of group IDs with transformations

" + }, + { + "group": "Type: Viewpoint", + "type": "Boolean", + "optional": false, + "field": "hide_IFC", + "description": "

A flag to hide the IFC

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": false, + "field": "screenshot", + "description": "

Base64 string representing the screenshot associated with the viewpoint

" + } + ], + "Type: Group": [ + { + "group": "Type: Group", + "type": "Number[3]", + "optional": false, + "field": "color", + "description": "

RGB colour values

" + }, + { + "group": "Type: Group", + "type": "ModelObjects", + "optional": false, + "field": "objects", + "description": "

List of objects in group

" + } + ], + "Type: ModelObjects": [ + { + "group": "Type: ModelObjects", + "type": "String", + "optional": false, + "field": "account", + "description": "

The account that has the model which contains the objects

" + }, + { + "group": "Type: ModelObjects", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model id that contains the objects

" + }, + { + "group": "Type: ModelObjects", + "type": "String[]", + "optional": false, + "field": "shared_ids", + "description": "

The shared ids of objects to be selected

" + } + ], + "Type: ClippingPlane": [ + { + "group": "Type: ClippingPlane", + "type": "Number[3]", + "optional": false, + "field": "normal", + "description": "

The normal of the plane defined for the clipping plane

" + }, + { + "group": "Type: ClippingPlane", + "type": "Number", + "optional": false, + "field": "distance", + "description": "

The distance for the clipping plane to the origin

" + }, + { + "group": "Type: ClippingPlane", + "type": "Number", + "optional": false, + "field": "clipDirection", + "description": "

The direction to the clipping plane will cut the model; above or below the plane. Possible values: 1 , -1.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/issues HTTP/1.1\n{\n \"name\": \"Amazing issue\",\n \"assigned_roles\": [\n \"jobA\"\n ],\n \"status\": \"open\",\n \"priority\": \"none\",\n \"topic_type\": \"for_information\",\n \"viewpoint\": {\n \"right\": [\n 0.8471935391426086,\n -2.2351741790771484e-8,\n 0.5312844514846802\n ],\n \"up\": [\n 0.14098820090293884,\n 0.9641460180282593,\n -0.22482173144817352\n ],\n \"position\": [\n -5828.818359375,\n 5268.15625,\n 7829.76171875\n ],\n \"look_at\": [\n -2445.6826171875,\n 3515.4658203125,\n 2434.966552734375\n ],\n \"view_dir\": [\n 0.5122357606887817,\n -0.2653723657131195,\n -0.8168182373046875\n ],\n \"near\": 20.835742950439453,\n \"far\": 10417.87109375,\n \"fov\": 1.0471975803375244,\n \"aspect_ratio\": 4.031496047973633,\n \"clippingPlanes\": [],\n \"override_groups\": [\n {\n \"color\": [\n \t 0,\n \t 106,\n \t 255,\n \t 52\n \t ],\n \t \"objects\": [\n {\n \"shared_ids\": [\n \"ffd49cfd-57fb-4c31-84f7-02b41352b54f\"\n ],\n \"account\": \"teamSpace1\",\n \"model\": \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\"\n }\n ]\n },\n {\n \"color\": [\n 96,\n 237,\n 61\n ],\n \t\"objects\": [\n \t {\n \"shared_ids\": [\n \"a4a14ee6-aa44-4f36-96bd-f80dbabf8ead\"\n ],\n \"account\": \"teamSpace1\",\n \"model\": \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\"\n }\n ]\n }\n ],\n \"transformation_groups\": [\n {\n \"transformation\": [1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16],\n \t \"objects\": [\n {\n \"shared_ids\": [\n \"ffd49cfd-57fb-4c31-84f7-02b41352b54f\"\n ],\n \"account\": \"teamSpace1\",\n \"model\": \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\"\n }\n ]\n },\n {\n \"color\": [\n 96,\n 237,\n 61\n ],\n \t\"objects\": [\n \t {\n \"shared_ids\": [\n \"a4a14ee6-aa44-4f36-96bd-f80dbabf8ead\"\n ],\n \"account\": \"teamSpace1\",\n \"model\": \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\"\n }\n ]\n }\n ],\n \"highlighted_group\": {\n \t\"objects\": [\n \t\t{\n \t\t\t\"shared_ids\": [\n \t\t\t\t\"60286d41-d897-4de6-a0ed-0929fa68be96\"\n \t\t\t],\n \t\t\t\"account\": \"teamSpace1\",\n \t\t\t\"model\": \"7cf61b4f-acdf-4295-b2d0-9b45f9f27418\"\n \t\t}\n \t],\n \t\"color\": [\n \t\t255,\n \t\t255,\n \t\t0\n \t]\n },\n \"hidden_group\": {\n \t\"objects\": [\n \t\t{\n \t\t\t\"shared_ids\": [\n \t\t\t\t\"57b0969f-6009-4e32-9153-2b17d3a3628b\"\n \t\t\t],\n \t\t\t\"account\": \"teamSpace1\",\n \t\t\t\"model\": \"b1fceab8-b0e9-4e45-850b-b9888efd6521\"\n \t\t}\n \t]\n }\n \"hideIfc\": true,\n \"screenshot\": \"iVBORw0KGgoAAAANSUhEUgAACAAAA...ggg==\"\n },\n \"desc\": \"This is the most awesome issue ever\",\n \"position\": [\n -3960.10205078125,\n 4487.1552734375,\n 3326.732177734375\n ]\n}", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n \"name\": \"Amazing issue\",\n \"assigned_roles\": [\n \"jobA\"\n ],\n \"status\": \"open\",\n \"priority\": \"none\",\n \"topic_type\": \"for_information\",\n \"owner\": \"teamSpace1\",\n \"desc\": \"This is the most awesome issue ever\",\n \"rev_id\": \"330f909b-9279-41aa-a87c-1c46f53a8e93\",\n \"creator_role\": \"jobA\",\n \"scale\": 1,\n \"position\": [\n -3960.10205078125,\n 4487.1552734375,\n 3326.732177734375\n ],\n \"_id\": \"9ba5fb10-c8db-11e9-8f2a-ada77612c97e\",\n \"created\": 1566918114625,\n \"number\": 1,\n \"thumbnail\": \"teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/issues/9ba5fb10-c8db-11e9-8f2a-ada77612c97e/thumbnail.png\",\n \"typePrefix\": \"Structural\",\n \"modelCode\": \"\",\n \"account\": \"teamSpace1\",\n \"model\": \"3549ddf6-885d-4977-87f1-eeac43a0e818\",\n \"viewpoint\": {\n \"right\": [\n 0.8471935391426086,\n -2.2351741790771484e-8,\n 0.5312844514846802\n ],\n \"up\": [\n 0.14098820090293884,\n 0.9641460180282593,\n -0.22482173144817352\n ],\n \"position\": [\n -5828.818359375,\n 5268.15625,\n 7829.76171875\n ],\n \"look_at\": [\n -2445.6826171875,\n 3515.4658203125,\n 2434.966552734375\n ],\n \"view_dir\": [\n 0.5122357606887817,\n -0.2653723657131195,\n -0.8168182373046875\n ],\n \"near\": 20.835742950439453,\n \"far\": 10417.87109375,\n \"fov\": 1.0471975803375244,\n \"aspect_ratio\": 4.031496047973633,\n \"clippingPlanes\": [],\n \"hidden_group_id\": \"119d5dc0-e223-11ea-8549-49012d4e4956\",\n \"highlighted_group_id\" : \"80c5a270-e223-11ea-8549-49012d4e4956\",\n \"override_group_ids\": [\n \"11952060-e223-11ea-8549-49012d4e4956\",\n \"bc5ca80-e6c7-11ea-bd51-ddd919e6418e\"\n ],\n \"transformation_group_ids\": [\n \"12345678-e223-11ea-8549-49012d4e4956\",\n \"12345678-e6c7-11ea-bd51-ddd919e6418e\"\n ],\n \"hideIfc\": true,\n \"screenshot\": \"teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/issues/9ba5fb10-c8db-11e9-8f2a-ada77612c97e/viewpoints/125ce196-852c-49ed-9a2f-f9a77aa03390/screenshot.png\",\n \"guid\": \"125ce196-852c-49ed-9a2f-f9a77aa03390\",\n \"screenshotSmall\": \"teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/issues/9ba5fb10-c8db-11e9-8f2a-ada77612c97e/viewpoints/125ce196-852c-49ed-9a2f-f9a77aa03390/screenshotSmall.png\"\n },\n \"comments\": [],\n \"extras\": {\n }\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues" + }, + { + "type": "post", + "url": "/:teamspace/:model/revision/:revId/issues", + "title": "Create issue on revision", + "name": "newIssueRev", + "group": "Issues", + "description": "

Creates a new issue for a particular revision. See here for more details.

", + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "revId", + "description": "

Revision ID

" + } + ] + } + } + }, + { + "type": "post", + "url": "/:teamspace/:model/revision/:revId/issues.bcfzip", + "title": "Post Issues BCF zip file by revision ID", + "name": "postIssuesBCF", + "group": "Issues", + "description": "

Upload Issues BCF file using current revision ID.

", + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "String", + "optional": false, + "field": "status", + "description": "

"ok" on success

" + } + ] + }, + "examples": [ + { + "title": "Success-Response:", + "content": "HTTP\n{\n\t\"status\":\"ok\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "revId", + "description": "

Revision ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/issues.html", + "title": "Issues response into as HTML", + "name": "renderIssuesHTML", + "group": "Issues", + "description": "

Render all Issues into a HTML webpage, response is rendered HTML.

", + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:revId/issues.html", + "title": "Issues response into as HTML by revision ID", + "name": "renderIssuesHTMLRid", + "group": "Issues", + "description": "

Render all Issues into a HTML webpage based on current revision ID.

", + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "revId", + "description": "

Revision ID

" + } + ] + } + } + }, + { + "type": "patch", + "url": "/:teamspace/:model/issues/:issueId", + "title": "Update issue", + "name": "updateIssue", + "group": "Issues", + "description": "

Updates an issue. It takes the part of the issue that can be updated. The system will create a system comment within the issue describing which values were changed. The user needs to be the teamspace administrator, the project administrator, has the same job as the creator of the issue, or has the issue assigned. In the case that the issue has been assigned to the user, the user cannot change it to the "closed" status.

If the issue is being updated to assigned to a job and the status of the issue has the value "for_approval", then the status of the issue is automatically changed to "in_progress".

If the user is changing the issue to the "for_approval" status, the issue will be assigned to the job that the creator of the issue.

", + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "[]String", + "optional": true, + "field": "assigned_roles", + "description": "

Job roles assigned to the issue

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "desc", + "description": "

Description of issue

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "status", + "description": "

The status of issue (values: "open", "in progress", "for approval", "closed")

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "topic_type", + "description": "

Topic type of issue (see here for available types)

" + }, + { + "group": "Request body", + "type": "[3]Number", + "optional": true, + "field": "position", + "description": "

Vector defining the pin position of the issue; empty if the issue has no pin

" + }, + { + "group": "Request body", + "type": "Number", + "optional": true, + "field": "due_date", + "description": "

Due date timestamp for the issue

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "priority", + "description": "

The priority of the issue (values: "none", "low", "medium", "high")

" + }, + { + "group": "Request body", + "type": "Number", + "optional": true, + "field": "scale", + "description": "

The scale factor of the issue

" + }, + { + "group": "Request body", + "type": "Viewpoint", + "optional": true, + "field": "viewpoint", + "description": "

The viewpoint and screenshot of the issue

" + }, + { + "group": "Request body", + "type": "Number", + "optional": true, + "field": "viewCount", + "description": "

The viewcount of the issue

" + }, + { + "group": "Request body", + "type": "Object", + "optional": true, + "field": "extras", + "description": "

A field containing any extras that wanted to be saved in the issue (typically used by BCF)

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "issueId", + "description": "

Issue ID

" + } + ], + "Type: Viewpoint": [ + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "right", + "description": "

Right vector of viewpoint indicating the direction of right in relative coordinates

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "up", + "description": "

Up vector of viewpoint indicating the direction of up in relative coordinates

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "position", + "description": "

Position vector indicates where in the world the viewpoint is positioned

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "look_at", + "description": "

Vector indicating where in the world the viewpoint is looking at

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "view_dir", + "description": "

Vector indicating the direction the viewpoint is looking at in relative coordinates

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "near", + "description": "

Vector indicating the near plane

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "far", + "description": "

Vector indicating the far plane

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "fov", + "description": "

Angle of the field of view

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "aspect_ratio", + "description": "

Aspect ratio of the fustrum

" + }, + { + "group": "Type: Viewpoint", + "type": "ClippingPlane[]", + "optional": true, + "field": "clippingPlanes", + "description": "

Clipping planes associated with the viewpoint

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": true, + "field": "highlighted_group_id", + "description": "

If the viewpoint is associated with one or more highlighted objects from the model this field has the value of a group ID generated to hold those objects

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": true, + "field": "hidden_group_id", + "description": "

If the viewpoint is associated with one or more hidden objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": true, + "field": "shown_group_id", + "description": "

If the viewpoint is associated with one or more shown objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: Viewpoint", + "type": "Group", + "optional": true, + "field": "highlighted_group", + "description": "

If the viewpoint is associated with one or more highlighted objects from the model this field has the value of a group definition for those objects (this shouldnt be use simultaneously with highlighted_group_id)

" + }, + { + "group": "Type: Viewpoint", + "type": "Group", + "optional": true, + "field": "hidden_group", + "description": "

If the viewpoint is associated with one or more hidden objects from the model this field has the value of a group id generated to hold those objects (this shouldnt be use simultaneously with hidden_group_id)

" + }, + { + "group": "Type: Viewpoint", + "type": "Group", + "optional": true, + "field": "shown_group", + "description": "

If the viewpoint is associated with one or more shown objects from the model this field has the definition of the group to hold those objects (this shouldnt be use simultaneously with shown_group_id)

" + }, + { + "group": "Type: Viewpoint", + "type": "Group[]", + "optional": true, + "field": "override_groups", + "description": "

If the viewpoint has one or more objects with colour override this field has an array of groups with one group for each colour

" + }, + { + "group": "Type: Viewpoint", + "type": "Group[]", + "optional": true, + "field": "transformation_groups", + "description": "

List of groups with transformations

" + }, + { + "group": "Type: Viewpoint", + "type": "String[]", + "optional": true, + "field": "transformation_group_ids", + "description": "

List of group IDs with transformations

" + }, + { + "group": "Type: Viewpoint", + "type": "Boolean", + "optional": false, + "field": "hide_IFC", + "description": "

A flag to hide the IFC

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": false, + "field": "screenshot", + "description": "

Base64 string representing the screenshot associated with the viewpoint

" + } + ], + "Type: Group": [ + { + "group": "Type: Group", + "type": "Number[3]", + "optional": false, + "field": "color", + "description": "

RGB colour values

" + }, + { + "group": "Type: Group", + "type": "ModelObjects", + "optional": false, + "field": "objects", + "description": "

List of objects in group

" + } + ], + "Type: ModelObjects": [ + { + "group": "Type: ModelObjects", + "type": "String", + "optional": false, + "field": "account", + "description": "

The account that has the model which contains the objects

" + }, + { + "group": "Type: ModelObjects", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model id that contains the objects

" + }, + { + "group": "Type: ModelObjects", + "type": "String[]", + "optional": false, + "field": "shared_ids", + "description": "

The shared ids of objects to be selected

" + } + ], + "Type: ClippingPlane": [ + { + "group": "Type: ClippingPlane", + "type": "Number[3]", + "optional": false, + "field": "normal", + "description": "

The normal of the plane defined for the clipping plane

" + }, + { + "group": "Type: ClippingPlane", + "type": "Number", + "optional": false, + "field": "distance", + "description": "

The distance for the clipping plane to the origin

" + }, + { + "group": "Type: ClippingPlane", + "type": "Number", + "optional": false, + "field": "clipDirection", + "description": "

The direction to the clipping plane will cut the model; above or below the plane. Possible values: 1 , -1.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "PATCH /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/issues/98c39770-c8e2-11e9-8f2a-ada77612c97e HTTP/1.1\n{\"status\":\"in progress\"}", + "type": "patch" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n \"_id\": \"98c39770-c8e2-11e9-8f2a-ada77612c97e\",\n \"name\": \"issue 2\",\n \"assigned_roles\": [\n \"jobC\"\n ],\n \"status\": \"in progress\",\n \"priority\": \"none\",\n \"topic_type\": \"for_information\",\n \"owner\": \"teamSpace1\",\n \"rev_id\": \"330f909b-9279-41aa-a87c-1c46f53a8e93\",\n \"creator_role\": \"jobA\",\n \"scale\": 1,\n \"created\": 1566921116263,\n \"desc\": \"(No Description)\",\n \"number\": 2,\n \"thumbnail\": \"teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/issues/98c39770-c8e2-11e9-8f2a-ada77612c97e/thumbnail.png\",\n \"comments\": [\n {\n \"guid\": \"febbe083-5a98-4711-8d60-d2ac06721f83\",\n \"created\": 1566924049774,\n \"owner\": \"teamSpace1\",\n \"action\": {\n \"property\": \"assigned_roles\",\n \"from\": \"\",\n \"to\": \"jobB\"\n },\n \"sealed\": true\n },\n {\n \"guid\": \"e8ba32b2-d58e-4c33-90f7-c6e0404ef1ee\",\n \"created\": 1566924062287,\n \"owner\": \"teamSpace1\",\n \"action\": {\n \"property\": \"assigned_roles\",\n \"from\": \"jobB\",\n \"to\": \"jobC\"\n },\n \"sealed\": true\n },\n {\n \"guid\": \"83117273-2698-4d2d-bd47-7cd31e6a7b14\",\n \"created\": 1566924080277,\n \"owner\": \"teamSpace1\",\n \"action\": {\n \"property\": \"status\",\n \"from\": \"open\",\n \"to\": \"in progress\"\n }\n }\n ],\n \"status_last_changed\": 1566924080277,\n \"account\": \"teamSpace1\",\n \"model\": \"3549ddf6-885d-4977-87f1-eeac43a0e818\",\n \"viewpoint\": {\n \"right\": [\n 0.9953137040138245,\n -4.656612873077393e-10,\n 0.09669896215200424\n ],\n \"up\": [\n 0.005437099374830723,\n 0.9984180331230164,\n -0.05596357211470604\n ],\n \"position\": [\n -3083.33251953125,\n 3886.8251953125,\n 8998.2783203125\n ],\n \"look_at\": [\n -2445.680419921875,\n 3515.46533203125,\n 2434.984130859375\n ],\n \"view_dir\": [\n 0.0965459868311882,\n -0.05622706934809685,\n -0.9937390685081482\n ],\n \"near\": 20.835796356201172,\n \"far\": 10417.8984375,\n \"fov\": 1.0471975803375244,\n \"aspect_ratio\": 3.1459293365478516,\n \"clippingPlanes\": [],\n \"highlighted_group_id\": \"98b9d370-c8e2-11e9-8f2a-ada77612c97e\",\n \"hideIfc\": true,\n \"screenshot\": \"teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/issues/98c39770-c8e2-11e9-8f2a-ada77612c97e/viewpoints/a1167d5f-2434-4a50-a158-d6a6745e7d6a/screenshot.png\",\n \"guid\": \"a1167d5f-2434-4a50-a158-d6a6745e7d6a\",\n \"screenshotSmall\": \"teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/issues/98c39770-c8e2-11e9-8f2a-ada77612c97e/viewpoints/a1167d5f-2434-4a50-a158-d6a6745e7d6a/screenshotSmall.png\"\n },\n \"position\": [],\n \"extras\": {\n }\n}", + "type": "json" + } + ], + "fields": { + "200": [ + { + "group": "200", + "type": "Object", + "optional": false, + "field": "Updated", + "description": "

Issue Object.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues" + }, + { + "type": "patch", + "url": "/:teamspace/:model/revision/:revId/issues/:issueId", + "title": "Update issue on revision", + "name": "updateIssueRev", + "group": "Issues", + "description": "

Updates an issue for a particular revision. See here for more details.

", + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "issueId", + "description": "

Issue ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "revId", + "description": "

Revision ID

" + } + ] + } + } + }, + { + "type": "post", + "url": "/:teamspace/jobs/:jobId/:user", + "title": "Assign a job", + "name": "addUserToJob", + "group": "Jobs", + "description": "

Assign a job to a user.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "optional": false, + "field": "jobId", + "description": "

Job ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user", + "description": "

User

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /acme/jobs/Job1/alice HTTP/1.1", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/job.js", + "groupTitle": "Jobs" + }, + { + "type": "post", + "url": "/:teamspace/jobs", + "title": "Create a new job", + "name": "createJob", + "group": "Jobs", + "description": "

Create a new job on teamspace.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "_id", + "description": "

Name of job

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "color", + "description": "

Colour of job

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "success": { + "fields": { + "Job object": [ + { + "group": "Job object", + "type": "String", + "optional": false, + "field": "_id", + "description": "

Name of job

" + }, + { + "group": "Job object", + "type": "String", + "optional": false, + "field": "color", + "description": "

Colour of job

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t_id:\"Job4\",\n\tcolor:\"#ffff00\"\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /acme/jobs HTTP/1.1\n{\n\t_id:\"Job4\",\n\tcolor:\"#ffff00\"\n}", + "type": "post" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/job.js", + "groupTitle": "Jobs" + }, + { + "type": "delete", + "url": "/:teamspace/jobs/:jobId", + "title": "Delete a job", + "name": "deleteJob", + "group": "Jobs", + "description": "

Delete a job from teamspace.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "jobId", + "description": "

Job ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "DELETE /acme/jobs/Job 1 HTTP/1.1", + "type": "delete" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/job.js", + "groupTitle": "Jobs" + }, + { + "type": "get", + "url": "/:teamspace/myJob", + "title": "Get user job", + "name": "getUserJob", + "group": "Jobs", + "description": "

Get job assigned to current user.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/myJob HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t_id\":\"Job1\",\n\t\"color\":\"ff00000\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/job.js", + "groupTitle": "Jobs", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/jobs/colors", + "title": "List colours", + "name": "listColors", + "group": "Jobs", + "description": "

List job colours.

", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "String[]", + "optional": false, + "field": "colors", + "description": "

List of job colours

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n[\n\t\"#ff0000\",\n\t\"#00ff00\",\n\t\"#0000ff\"\n]", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/jobs/colors HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/job.js", + "groupTitle": "Jobs", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/jobs", + "title": "List all jobs", + "name": "listJobs", + "group": "Jobs", + "description": "

List of all jobs defined in teamspace.

", + "success": { + "fields": { + "Job object": [ + { + "group": "Job object", + "type": "String", + "optional": false, + "field": "_id", + "description": "

Name of job

" + }, + { + "group": "Job object", + "type": "String", + "optional": false, + "field": "color", + "description": "

Colour of job

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"_id\":\"Job1\",\n\t\t\"color\":\"#ff0000\"\n\t},\n\t{\n\t\t\"_id\":\"Job2\",\n\t\t\"color\":\"#00ff00\"\n\t},\n\t{\n\t\t\"_id\":\"Job3\",\n\t\t\"color\":\"#0000ff\"\n\t}\n]", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/jobs HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/job.js", + "groupTitle": "Jobs", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + } + }, + { + "type": "put", + "url": "/:teamspace/jobs/:jobId", + "title": "Update job", + "name": "updateJob", + "group": "Jobs", + "description": "

Update job.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "jobId", + "description": "

Job ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "_id", + "description": "

Name of job

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "color", + "description": "

Colour of job

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "PUT /acme/jobs/Job1 HTTP/1.1\n{\n\t_id:\"Renamed Job\",\n\tcolor:\"#00ffff\"\n}", + "type": "put" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/job.js", + "groupTitle": "Jobs" + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/hereadminlabeloverlay/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here admin layer", + "name": "getHereAdminOverlayTile", + "group": "Maps", + "description": "

Retrieve a Here Maps administrative labels overlay tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/hereadminlabeloverlay/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/hereaerial/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here aerial tile", + "name": "getHereAerialMapsTile", + "group": "Maps", + "description": "

Retrieve a Here Maps aerial map tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/hereaerial/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/hereinfo", + "title": "Here Maps options", + "name": "getHereBaseInfo", + "group": "Maps", + "description": "

Get Here Maps service options.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/ HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n\n\t\n\t\t\n\t\n\t\n\t\t\n\t\n\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\n\t\n", + "type": "xml" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/herebuildings/:lat/:long/tile.json", + "title": "Here building elevation", + "name": "getHereBuildingsFromLongLat", + "group": "Maps", + "description": "

Retrieve building elevation information from Here Maps.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "lat", + "description": "

Latitude

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "long", + "description": "

Longitude

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/herebuildings/51.524575/-0.139088/tile.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"Rows\":[\n\t\t{\n\t\t\t\"BUILDING_ID\":\"700567270\",\n\t\t\t\"FACE_ID\":\"700567270\",\n\t\t\t\"FEATURE_TYPE\":\"2005700\",\n\t\t\t\"HEIGHT\":\"22\",\n\t\t\t\"GROUND_CLEARANCE\":null,\n\t\t\t\"CF_ID\":\"1400645341\",\n\t\t\t\"HAS_3DLM\":\"N\",\n\t\t\t\"NAME\":null,\n\t\t\t\"LAT\":\"5150745,9,-12,-4,10,-5,2\",\n\t\t\t\"LON\":\"-14284,18,14,-9,-12,-9,-2\",\n\t\t\t\"INNER_LAT\":null,\n\t\t\t\"INNER_LON\":null\n\t\t},\n\t\t{\n\t\t\t\"BUILDING_ID\":\"700567273\",\n\t\t\t\"FACE_ID\":\"700567273\",\n\t\t\t\"FEATURE_TYPE\":\"2005700\",\n\t\t\t\"HEIGHT\":\"11\",\n\t\t\t\"GROUND_CLEARANCE\":null,\n\t\t\t\"CF_ID\":\"1400645344\",\n\t\t\t\"HAS_3DLM\":\"N\",\n\t\t\t\"NAME\":null,\n\t\t\t\"LAT\":\"5150742,-12,-4,-4,11,5,4\",\n\t\t\t\"LON\":\"-14252,14,-9,-8,-14,8,9\",\n\t\t\t\"INNER_LAT\":null,\n\t\t\t\"INNER_LON\":null\n\t\t}\n\t]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

" + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/heregrey/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here grey tile", + "name": "getHereGreyTile", + "group": "Maps", + "description": "

Retrieve a Here Maps grey map tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/heregrey/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/heregreytransit/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here transit (grey) tile", + "name": "getHereGreyTransitTile", + "group": "Maps", + "description": "

Retrieve a Here Maps grey transit map tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/heregreytransit/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/herehybrid/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here hybrid tile", + "name": "getHereHybridTile", + "group": "Maps", + "description": "

Retrieve a Here Maps hybrid map tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/herehybrid/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/herelabeloverlay/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here label layer", + "name": "getHereLabelOverlayTile", + "group": "Maps", + "description": "

Retrieve a Here Maps label overlay tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/herelabeloverlay/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/herelinelabeloverlay/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here line & label layer", + "name": "getHereLineLabelOverlayTile", + "group": "Maps", + "description": "

Retrieve a Here Maps line and label overlay tile image of street lines, city centre labels, and item labels.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/herelinelabeloverlay/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/here/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here map tile", + "name": "getHereMapsTile", + "group": "Maps", + "description": "

Retrieve a Here Maps map tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/here/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/herepoi/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here POI tile", + "name": "getHerePOITile", + "group": "Maps", + "description": "

Retrieve a Here Maps point-of-interest (POI) map tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/herepoi/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/hereterrain/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here terrain tile", + "name": "getHereTerrainTile", + "group": "Maps", + "description": "

Retrieve a Here Maps terrain map tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/hereterrain/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/heretollzone/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here toll zone tile", + "name": "getHereTollZoneTile", + "group": "Maps", + "description": "

Retrieve a Here Maps toll zone map tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/heretollzone/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/heretrafficflow/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here traffic layer", + "name": "getHereTrafficFlowTile", + "group": "Maps", + "description": "

Retrieve a Here Maps traffic flow overlay tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/heretrafficflow/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "min_traffic_congestion", + "description": "

Specifies the minimum traffic congestion level to use for rendering traffic flow (free, heavy, queuing, blocked)

" + }, + { + "group": "Query", + "type": "DateTime", + "optional": true, + "field": "time", + "description": "

Date and time for showing historical traffic patterns

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/heretraffic/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here traffic tile", + "name": "getHereTrafficTile", + "group": "Maps", + "description": "

Retrieve a Here Maps traffic map tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/heretraffic/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "min_traffic_congestion", + "description": "

Specifies the minimum traffic congestion level to use for rendering traffic flow (free, heavy, queuing, blocked)

" + }, + { + "group": "Query", + "type": "DateTime", + "optional": true, + "field": "time", + "description": "

Date and time for showing historical traffic patterns

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/heretruckoverlay/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here truck restrictions layer", + "name": "getHereTruckRestrictionsOverlayTile", + "group": "Maps", + "description": "

Retrieve a Here Maps truck restrictions overlay tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/heretruckoverlay/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/heretruck/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here truck restrictions tile", + "name": "getHereTruckRestrictionsTile", + "group": "Maps", + "description": "

Retrieve a Here Maps truck restrictions map tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/heretruck/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/osm/:zoomLevel/:gridx/:gridy.png", + "title": "OSM map tile", + "name": "getOSMTile", + "group": "Maps", + "description": "

Retrieve an Open Street Map (OSM) map tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/osm/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps", + "title": "List maps", + "name": "listMaps", + "group": "Maps", + "description": "

List the available geographic information system (GIS) sources and map layers.

", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Object[]", + "optional": false, + "field": "maps", + "description": "

List of available map objects

" + } + ], + "Map object": [ + { + "group": "Map object", + "type": "String", + "optional": false, + "field": "name", + "description": "

Name of map provider

" + }, + { + "group": "Map object", + "type": "Object[]", + "optional": false, + "field": "layers", + "description": "

List of available map layer objects

" + } + ], + "Layer object": [ + { + "group": "Layer object", + "type": "String", + "optional": false, + "field": "name", + "description": "

Name of map layer

" + }, + { + "group": "Layer object", + "type": "String", + "optional": false, + "field": "source", + "description": "

Map source identifier

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"maps\":[\n\t\t{\n\t\t\t\"name\":\"Open Street Map\",\n\t\t\t\"layers\":[\n\t\t\t\t{\n\t\t\t\t\t\"name\":\"Map Tiles\",\n\t\t\t\t\t\"source\":\"OSM\"\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"name\":\"Here\",\n\t\t\t\"layers\":[\n\t\t\t\t{\n\t\t\t\t\t\"name\":\"Map Tiles\",\n\t\t\t\t\t\"source\":\"HERE\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"name\":\"Traffic Flow\",\n\t\t\t\t\t\"source\":\"HERE_TRAFFIC_FLOW\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"name\":\"Truck Restrictions\",\n\t\t\t\t\t\"source\":\"HERE_TRUCK_OVERLAY\"\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t]\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/meta/4DTaskSequence.json", + "title": "Get All metadata for 4D Sequence Tags", + "name": "getAllIdsWith4DSequenceTag", + "group": "Meta", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/meta.js", + "groupTitle": "Meta" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:rev/meta/4DTaskSequence.json", + "title": "Get All metadata with 4D Sequence Tags by revision", + "name": "getAllIdsWith4DSequenceTagRev", + "group": "Meta", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

Revision

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/meta.js", + "groupTitle": "Meta" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/meta/all.json?filter=:filter", + "title": "Get all metadata", + "name": "getAllMetadata", + "group": "Meta", + "description": "

Get all objects in the tree with their metadata.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "filter", + "description": "

(optional) properties to filter for, comma separated

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/revision/master/head/meta/all.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n \"data\": [\n {\n \"_id\": \"2f461edf-4544-412a-bb84-ffdb3bbe563b\",\n \"metadata\": {\n \"IFC Type\": \"IfcBuilding\",\n \"IFC GUID\": \"00tMo7QcxqWdIGvc4sMN2A\",\n \"BuildingID\": \"n/a\",\n \"IsPermanentID\": \"True\",\n \"OccupancyType\": \"Private dwelling\",\n \"IsLandmarked\": \"True\",\n \"NumberOfStoreys\": 2\n },\n \"parents\": [\n \"9eeddbe2-750d-46fb-988f-bcf9ec2ecf51\"\n ]\n },\n {\n \"_id\": \"85ad29bd-cd99-4472-a92f-86266b07e57d\",\n \"metadata\": {\n \"IFC Type\": \"IfcSite\",\n \"IFC GUID\": \"20FpTZCqJy2vhVJYtjuIce\"\n },\n \"parents\": [\n \"48359ad0-9b6d-44ed-ae93-47e2ec69ea88\"\n ]\n },\n {\n \"_id\": \"b5fe5dcf-ce8c-4b1e-a96b-bdc5aa001963\",\n \"metadata\": {\n \"IFC Type\": \"IfcBuildingElementProxy\",\n \"IFC GUID\": \"3VkTAO0fr0XQHS3DxQzfxm\",\n \"Reference\": \"LegoRoundTree\"\n },\n \"parents\": [\n \"2bf2a864-5cb0-41ba-85a8-c2cffc3da06d\"\n ]\n },\n {\n \"_id\": \"c4682cf2-7b2a-41c7-8fe2-c0c39512dd99\",\n \"metadata\": {\n \"IFC Type\": \"IfcBuildingStorey\",\n \"IFC GUID\": \"1oZ0wPs_PE8ANCPg3bIs4j\",\n \"AboveGround\": \"False\"\n },\n \"parents\": [\n \"323a9900-ece1-4857-8980-ec96ffc7f681\"\n ]\n }\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/meta.js", + "groupTitle": "Meta" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:rev/meta/all.json?filter=:filter", + "title": "Get all metadata by revision", + "name": "getAllMetadataByRev", + "group": "Meta", + "description": "

Get all tree objects with their metadata tags by revision. See more details here.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

Revision to get metadata from

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "filter", + "description": "

(optional) properties to filter for, comma separated

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/meta.js", + "groupTitle": "Meta" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/meta/findObjsWith/:metaKey.json", + "title": "Get ids by metadata", + "name": "getIdsWithMetadataField", + "group": "Meta", + "description": "

Get ids of tree objects which has a particular metadata key (in the latest revision). It also returns the metadata value for that key.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "metaKey", + "description": "

Unique metadata key

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/revision/master/head/meta/findObjsWith/IsLandmarked.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n \"data\": [\n {\n \"_id\": \"2f461edf-4544-412a-bb84-ffdb3bbe563b\",\n \"metadata\": {\n \"value\": \"True\"\n },\n \"parents\": [\n \"9eeddbe2-750d-46fb-988f-bcf9ec2ecf51\"\n ]\n }\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/meta.js", + "groupTitle": "Meta" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:rev/meta/findObjsWith/:metaKey.json", + "title": "Get ids by metadata", + "name": "getIdsWithMetadataFieldByRev", + "group": "Meta", + "description": "

Get ids of tree objects which has a particular metadata key from a particular revision. See more details here.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

Revision to get metadata from

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "metaKey", + "description": "

Unique meta key

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/meta.js", + "groupTitle": "Meta" + }, + { + "type": "get", + "url": "/:teamspace/:model/meta/:id.json", + "title": "Get metadata", + "name": "getMetadataById", + "group": "Meta", + "description": "

Get all metadata tags by revision. See more details here.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "optional": false, + "field": "id", + "description": "

Meta Unique ID

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/meta/b5fe5dcf-ce8c-4b1e-a96b-bdc5aa001963.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n \"meta\": [\n {\n \"_id\": \"b5fe5dcf-ce8c-4b1e-a96b-bdc5aa001963\",\n \"name\": \"LegoRoundTree:LegoRoundTree:302403\",\n \"metadata\": {\n \"IFC Type\": \"IfcBuildingElementProxy\",\n \"IFC GUID\": \"3VkTAO0fr0XQHS3DxQzfxm\",\n \"Reference\": \"LegoRoundTree\"\n }\n }\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/meta.js", + "groupTitle": "Meta" + }, + { + "type": "get", + "url": "/:teamspace/:model/meta/keys", + "title": "Get array of metadata fields", + "name": "getMetadataFields", + "group": "Meta", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/meta/keys HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "[\n \"AboveGround\",\n \"BuildingID\",\n \"IFC GUID\",\n \"IFC Type\",\n \"IsLandmarked\",\n \"IsPermanentID\",\n \"NumberOfStoreys\",\n \"OccupancyType\",\n \"Reference\"\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/meta.js", + "groupTitle": "Meta" + }, + { + "type": "post", + "url": "/:teamspace/:model/revision(/master/head/|/:revId)/meta/rules?filter=:filter", + "title": "Filter metadata by rules", + "name": "queryMetadataByRules", + "group": "Meta", + "description": "

Get all objects matching filter rules in the tree with their metadata.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "filter", + "description": "

(optional) properties to filter for, comma separated

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "meshids", + "description": "

Flag that returns Mesh IDs for matching rule queries

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage (/master/head)", + "content": "POST /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/revision/master/head/meta/rules HTTP/1.1\n[\n\t{\n\t\t\"field\":\"Area\",\n\t\t\"operator\":\"GT\",\n\t\t\"values\":[5]\n\t},\n\t{\n\t\t\"field\":\"IFC Type\",\n\t\t\"operator\":\"IS\",\n\t\t\"values\":[\n\t\t\t\"IfcWall\",\n\t\t\t\"IfcDoor\"\n\t\t]\n\t}\n]", + "type": "post" + }, + { + "title": "Example usage (/:revId)", + "content": "POST /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/revision/00000000-0000-0000-0000-000000000001/meta/rules HTTP/1.1", + "type": "post" + }, + { + "title": "Example usage (mesh IDs)", + "content": "POST /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/revision/master/head/meta/rules?meshids=true HTTP/1.1", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success (metadata):", + "content": "{\n \"data\": [\n {\n \"_id\": \"2f461edf-4544-412a-bb84-ffdb3bbe563b\",\n \"metadata\": {\n \"IFC Type\": \"IfcBuilding\",\n \"IFC GUID\": \"00tMo7QcxqWdIGvc4sMN2A\",\n \"BuildingID\": \"n/a\",\n \"IsPermanentID\": \"True\",\n \"OccupancyType\": \"Private dwelling\",\n \"IsLandmarked\": \"True\",\n \"Area\": 9000,\n \"NumberOfStoreys\": 2\n },\n \"parents\": [\n \"9eeddbe2-750d-46fb-988f-bcf9ec2ecf51\"\n ]\n },\n {\n \"_id\": \"85ad29bd-cd99-4472-a92f-86266b07e57d\",\n \"metadata\": {\n \"IFC Type\": \"IfcWall\",\n \"IFC GUID\": \"20FpTZCqJy2vhVJYtjuIce\"\n },\n \"parents\": [\n \"48359ad0-9b6d-44ed-ae93-47e2ec69ea88\"\n ]\n },\n {\n \"_id\": \"b5fe5dcf-ce8c-4b1e-a96b-bdc5aa001963\",\n \"metadata\": {\n \"IFC Type\": \"IfcBuildingElementProxy\",\n \"IFC GUID\": \"3VkTAO0fr0XQHS3DxQzfxm\",\n \"Area\": 6,\n \"Reference\": \"LegoRoundTree\"\n },\n \"parents\": [\n \"2bf2a864-5cb0-41ba-85a8-c2cffc3da06d\"\n ]\n },\n {\n \"_id\": \"c4682cf2-7b2a-41c7-8fe2-c0c39512dd99\",\n \"metadata\": {\n \"IFC Type\": \"IfcDoor\",\n \"IFC GUID\": \"1oZ0wPs_PE8ANCPg3bIs4j\",\n \"AboveGround\": \"False\"\n },\n \"parents\": [\n \"323a9900-ece1-4857-8980-ec96ffc7f681\"\n ]\n }\n ]\n}", + "type": "json" + }, + { + "title": "Success (federation metadata):", + "content": "{\n \"data\": [],\n \"subModels\": [\n {\n \"data\": [\n {\n \"_id\": \"2f461edf-4544-412a-bb84-ffdb3bbe563b\",\n \"metadata\": {\n \"IFC Type\": \"IfcBuilding\",\n \"IFC GUID\": \"00tMo7QcxqWdIGvc4sMN2A\",\n \"BuildingID\": \"n/a\",\n \"IsPermanentID\": \"True\",\n \"OccupancyType\": \"Private dwelling\",\n \"IsLandmarked\": \"True\",\n \"Area\": 9000,\n \"NumberOfStoreys\": 2\n },\n \"parents\": [\n \"9eeddbe2-750d-46fb-988f-bcf9ec2ecf51\"\n ]\n },\n {\n \"_id\": \"85ad29bd-cd99-4472-a92f-86266b07e57d\",\n \"metadata\": {\n \"IFC Type\": \"IfcWall\",\n \"IFC GUID\": \"20FpTZCqJy2vhVJYtjuIce\"\n },\n \"parents\": [\n \"48359ad0-9b6d-44ed-ae93-47e2ec69ea88\"\n ]\n },\n {\n \"_id\": \"b5fe5dcf-ce8c-4b1e-a96b-bdc5aa001963\",\n \"metadata\": {\n \"IFC Type\": \"IfcBuildingElementProxy\",\n \"IFC GUID\": \"3VkTAO0fr0XQHS3DxQzfxm\",\n \"Area\": 6,\n \"Reference\": \"LegoRoundTree\"\n },\n \"parents\": [\n \"2bf2a864-5cb0-41ba-85a8-c2cffc3da06d\"\n ]\n },\n {\n \"_id\": \"c4682cf2-7b2a-41c7-8fe2-c0c39512dd99\",\n \"metadata\": {\n \"IFC Type\": \"IfcDoor\",\n \"IFC GUID\": \"1oZ0wPs_PE8ANCPg3bIs4j\",\n \"AboveGround\": \"False\"\n },\n \"parents\": [\n \"323a9900-ece1-4857-8980-ec96ffc7f681\"\n ]\n }\n ],\n \"account\": \"acme\",\n \"model\": \"00000000-0000-0000-0000-000000000001\"\n },\n {\n \"data\": [\n {\n \"_id\": \"2f461edf-4544-412a-bb84-ffdb3bbe563b\",\n \"metadata\": {\n \"IFC Type\": \"IfcBuilding\",\n \"IFC GUID\": \"12tTo3QcxqWd5Gvc4sABCA\",\n \"BuildingID\": \"Site B\",\n \"IsPermanentID\": \"True\",\n \"OccupancyType\": \"Private dwelling\",\n \"IsLandmarked\": \"True\",\n \"Area\": 20,\n \"NumberOfStoreys\": 1\n },\n \"parents\": [\n \"9eeddbe2-750d-46fb-988f-bcf9ec2ecf51\"\n ]\n }\n ],\n \"account\": \"acme\",\n \"model\": \"00000000-0000-0000-0000-000000000002\"\n }\n ]\n}", + "type": "json" + }, + { + "title": "Success (mesh IDs):", + "content": "[\n\t{\n\t\t\"account\": \"acme\",\n\t\t\"model\": \"00000000-0000-0000-0000-000000000000\",\n\t\t\"mesh_ids\": [\n\t\t\t\"11111111-1111-1111-1111-111111111111\",\n\t\t\t\"22222222-2222-2222-2222-222222222222\",\n\t\t\t\"33333333-3333-3333-3333-333333333333\",\n\t\t\t\"44444444-4444-4444-4444-444444444444\"\n\t\t]\n\t}\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/meta.js", + "groupTitle": "Meta" + }, + { + "type": "patch", + "url": "/:teamspace/models/permissions", + "title": "Batch update model permissions", + "name": "batchUpdateModelPermissions", + "group": "Model", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace.

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "ModelPermissions[]", + "optional": false, + "field": "BODY", + "description": "

List of model permissions

" + } + ], + "Request body: ModelPermissions": [ + { + "group": "Request body: ModelPermissions", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Request body: ModelPermissions", + "type": "Permission[]", + "optional": false, + "field": "permissions", + "description": "

List of user permissions

" + } + ], + "Request body: Permission": [ + { + "group": "Request body: Permission", + "type": "string", + "optional": false, + "field": "user", + "description": "

User ID

" + }, + { + "group": "Request body: Permission", + "type": "string", + "optional": false, + "field": "permission", + "description": "

Permission type ('viewer'|'commenter'|'collaborator'|'').

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "PATCH /acme/models/permissions HTTP/1.1\n[\n {\n model: \"00000000-0000-0000-0000-000000000000\",\n permissions: [\n {\n user: \"alice\",\n permission: \"collaborator\"\n },\n {\n user: \"bob\",\n permission: \"commenter\"\n },\n {\n user: \"mike\",\n permission: \"\"\n }\n ]\n },\n {\n model: \"11111111-1111-1111-1111-111111111111\",\n permissions: [\n {\n user: \"charlie\",\n permission: \"viewer\"\n }\n ]\n },\n {\n model: \"22222222-2222-2222-2222-222222222222\",\n permissions: [\n {\n user: \"dave\",\n permission: \"commenter\"\n },\n {\n user: \"eve\",\n permission: \"\"\n }\n ]\n }\n]", + "type": "patch" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n status: \"ok\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "post", + "url": "/:teamspace/model", + "title": "Create a model", + "name": "createModel", + "group": "Model", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "project", + "description": "

Name of project in which the model will be created

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "modelName", + "description": "

Name of the model to be created

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "unit", + "description": "

The unit in which the model is specified

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "desc", + "description": "

A description of the model

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "code", + "description": "

A code to be associated with the model; it can be of maximum 5 letters (a-z) and numbers

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "type", + "description": "

The type of the model

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /teamSpace1/model HTTP/1.1\n{\n project: \"classic project\",\n modelName: \"awesomeModel\",\n unit: \"ft\",\n desc: \"This is an awesome model!\",\n code: \"awe12\",\n type: \"Mechanical\"\n}", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n account: \"teamSpace1\",\n model: \"17d09947-368e-4748-877f-d105842c6681\",\n name: \"awesomeModel\",\n permissions: [\n \"change_model_settings\",\n \"upload_files\",\n \"create_issue\",\n \"comment_issue\",\n \"view_issue\",\n \"view_model\",\n \"download_model\",\n \"edit_federation\",\n \"delete_federation\",\n \"delete_model\",\n \"manage_model_permission\"\n ],\n setting: {\n type: \"Mechanical\",\n desc: \"\",\n name: \"awesomeModel\",\n _id: \"17d09947-368e-4748-877f-d105842c6681\",\n subModels: [],\n surveyPoints: [],\n properties: {\n unit: \"ft\"\n },\n permissions: [],\n status: \"ok\"\n }\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "delete", + "url": "/:teamspace/:model", + "title": "Delete Model.", + "name": "deleteModel", + "group": "Model", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to delete.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "DELETE /teamSpace1/17d09947-368e-4748-877f-d105842c6681 HTTP/1.1", + "type": "delete" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n \"account\": \"teamSpace1\",\n \"model\": \"17d09947-368e-4748-877f-d105842c6681\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/download/latest", + "title": "Download model", + "name": "downloadModel", + "group": "Model", + "description": "

It returns the model file using the latest revision.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to download.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/b1fceab8-b0e9-4e45-850b-b9888efd6521/download/latest HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success (with headers):", + "content": "\nHTTP/1.1 200 OK\nX-Powered-By: Express\nVary: Origin\nAccess-Control-Allow-Credentials: true\nContent-Length: 11964\nContent-Disposition: attachment;filename=3DrepoBIM_blocks.obj\nset-cookie: connect.sid=s%3Ax4mDfLE-NqmPUO5tSSxPAyMjgov6YRge.bVSUoML3obJNp1XuObpbtXY44RjgEhJtsTz%2FwhwIckE; Domain=local.3drepo.io; Path=/; Expires=Tue, 27 Aug 2019 12:18:34 GMT; HttpOnly\nDate: Tue, 27 Aug 2019 11:18:34 GMT\nConnection: keep-alive\n\n/***** FILE CONTENTS ******\\", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/settings/heliSpeed", + "title": "Get model heli speed", + "name": "getHeliSpeed", + "group": "Model", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

The modelId to get Heli speed for.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/settings/heliSpeed HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\"heliSpeed\":1}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/idMap.json", + "title": "Get ID map", + "name": "getIdMap", + "group": "Model", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model id to Get ID Map for.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage (federation):", + "content": "GET /teamSpace1/5ce7dd19-1252-4548-a9c9-4a5414f2e0c5/revision/master/head/idMap.json HTTP/1.1", + "type": "get" + }, + { + "title": "Example usage (model):", + "content": "GET /teamSpace1/b1fceab8-b0e9-4e45-850b-b9888efd6521/revision/master/head/idMap.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success (federation):", + "content": "{\n mainTree: {\n idMap: {\n 261bf9df-64d7-4642-8bb2-0a79abd370ec: \"d86573c9-beec-4f06-b194-18b6983a3d71\",\n 528c62e6-5cf8-4868-b5ff-733c128b4b4e: \"6047f788-8317-45ff-b692-29e03071ec63\",\n 7d5ce878-6ec9-4c11-a96d-12b68c9e9c7c: \"7d9eefe0-2b8a-4de3-9acb-c216c9b48c9f\",\n 95744e20-4b4d-4fc1-8ba7-1f31ebf772b6: \"d2c0e845-b392-429e-86bd-6c7453b78654\",\n 71634e9c-da2c-4ea7-bd04-44971d3fd8dc: \"6e40ecbc-bb2f-4504-8f00-80b12fb04443\",\n a70dd58c-c09e-4ed4-ac7e-914dbd145302: \"f1a14ded-6528-4937-b31d-ce4b3ca813d8\",\n d68cf5e7-4d0f-4702-8a92-c81b72928c54: \"d012d6ba-01d2-4460-921e-72539a1ac197\"\n }\n },\n subModels: [\n {\n account: \"teamSpace1\",\n model: \"b1fceab8-b0e9-4e45-850b-b9888efd6521\",\n idMap: {\n a82a3b7f-bcd9-4487-8f94-370fa1f2ea4e: \"57b0969f-6009-4e32-9153-2b17d3a3628b\",\n 33c36fee-622d-46a5-8be1-a1bd295aa7d1: \"1e47d53e-cad8-489b-89ea-7c6c7b8d0e6c\"\n }\n },\n {\n account: \"teamSpace1\",\n model: \"7cf61b4f-acdf-4295-b2d0-9b45f9f27418\",\n idMap: {\n 8a1f9cad-18d8-47ce-9cbd-08ba53858ced: \"60286d41-d897-4de6-a0ed-0929fa68be96\",\n ea37c2ed-39d4-4236-843c-332d52876c96: \"9c4be293-0d8f-4e37-b115-d2c752824bfe\"\n }\n },\n {\n account: \"teamSpace1\",\n model: \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\",\n idMap: {\n 8ef1c52e-8838-46dc-9825-efe46aa10041: \"a4a14ee6-aa44-4f36-96bd-f80dbabf8ead\",\n ecc25d63-87e0-4600-ae60-f38f766bc9e4: \"ffd49cfd-57fb-4c31-84f7-02b41352b54f\",\n 3abc5450-5db8-459b-80ea-cb9fca9ccedd: \"a6947de3-25f4-4c2c-a150-22f0ed9ce4dd\"\n }\n }\n ]\n}", + "type": "json" + }, + { + "title": "Success (model):", + "content": "{\n mainTree: {\n idMap: {\n a82a3b7f-bcd9-4487-8f94-370fa1f2ea4e: \"57b0969f-6009-4e32-9153-2b17d3a3628b\",\n 33c36fee-622d-46a5-8be1-a1bd295aa7d1: \"1e47d53e-cad8-489b-89ea-7c6c7b8d0e6c\"\n }\n },\n subModels: []\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/idToMeshes.json", + "title": "Get ID to meshes", + "name": "getIdToMeshes", + "group": "Model", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to get ID Meshes for.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/b1fceab8-b0e9-4e45-850b-b9888efd6521/revision/master/head/idToMeshes.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n mainTree: {\n a82a3b7f-bcd9-4487-8f94-370fa1f2ea4e: [\n \"a82a3b7f-bcd9-4487-8f94-370fa1f2ea4e\"\n ],\n 33c36fee-622d-46a5-8be1-a1bd295aa7d1: [\n \"a82a3b7f-bcd9-4487-8f94-370fa1f2ea4e\"\n ]\n },\n subModels: []\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/:uid.json.mpc", + "title": "Get JSON Mpc", + "name": "getJsonMpc", + "group": "Model", + "description": "

Get the unity bundle mpc json file. The path for this api is provided in the data retrieved by either one of the endpoints /:teamspace/:model/revision/master/head/unityAssets.json or /:teamspace/:model/revision/:rev/unityAssets.json

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

id of the model to get JSON Mpc for.

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "uid", + "description": "

id of the json.mpc file

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/92fc213b-1bab-49a4-b10e-f4368a52d500_unity.json.mpc HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n numberOfIDs: 1,\n maxGeoCount: 1,\n mapping: [\n {\n name: \"ce413e99-8469-4ed0-86e3-ff50bf4fed89\",\n sharedID: \"a876e59a-8cda-4d61-b438-c74ce7b8855d\",\n min: [\n -3515.19556,\n -5790.91504,\n 0\n ],\n max: [\n 0,\n 0,\n 3502.927\n ],\n usage: [\n \"92fc213b-1bab-49a4-b10e-f4368a52d500_0\"\n ]\n }\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/modelProperties.json", + "title": "Get model properties", + "name": "getModelProperties", + "group": "Model", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to get properties for.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/b1fceab8-b0e9-4e45-850b-b9888efd6521/revision/master/head/modelProperties.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n properties: {\n hiddenNodes: []\n },\n subModels: []\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model.json", + "title": "Get model settings", + "name": "getModelSetting", + "group": "Model", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "Object", + "optional": false, + "field": "model", + "description": "

The modelId to get settings for.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n _id: \"3549ddf6-885d-4977-87f1-eeac43a0e818\",\n timestamp: \"2019-05-13T16:54:44.000Z\",\n type: \"Structural\",\n desc: \"\",\n name: \"Lego Tree\",\n subModels: [],\n surveyPoints: [],\n properties: {\n unit: \"mm\"\n },\n permissions: [\n \"change_model_settings\",\n \"upload_files\",\n \"create_issue\",\n \"comment_issue\",\n \"view_issue\",\n \"view_model\",\n \"download_model\",\n \"edit_federation\",\n \"delete_federation\",\n \"delete_model\",\n \"manage_model_permission\"\n ],\n status: \"ok\",\n id: \"3549ddf6-885d-4977-87f1-eeac43a0e818\",\n model: \"3549ddf6-885d-4977-87f1-eeac43a0e818\",\n account: \"teamSpace1\",\n headRevisions: {\n }\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/fulltree.json", + "title": "Get tree", + "name": "getModelTree", + "group": "Model", + "description": "

Returns the full tree for the model

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/revision/master/head/fulltree.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n mainTree: {\n nodes: {\n account: \"teamSpace1\",\n project: \"3549ddf6-885d-4977-87f1-eeac43a0e818\",\n type: \"transformation\",\n name: \"RootNode\",\n path: \"73a41cea-4c6b-47ed-936b-3f5641aecb52\",\n _id: \"73a41cea-4c6b-47ed-936b-3f5641aecb52\",\n shared_id: \"4dd46b6f-099e-42cd-b045-6460200e7995\",\n children: [\n {\n account: \"teamSpace1\",\n project: \"3549ddf6-885d-4977-87f1-eeac43a0e818\",\n type: \"transformation\",\n name: \"Fouliiferous Tree H64_2\",\n path: \"73a41cea-4c6b-47ed-936b-3f5641aecb52__33fe7c13-17a4-43d6-af03-ceae6880322f\",\n _id: \"33fe7c13-17a4-43d6-af03-ceae6880322f\",\n shared_id: \"b69a8384-c29d-4954-9efa-4c7bc14f1d3d\",\n children: [\n {\n account: \"teamSpace1\",\n project: \"3549ddf6-885d-4977-87f1-eeac43a0e818\",\n type: \"mesh\",\n name: \"Fouliiferous Tree H64\",\n path: \"73a41cea-4c6b-47ed-936b-3f5641aecb52__33fe7c13-17a4-43d6-af03-ceae6880322f__ce413e99-8469-4ed0-86e3-ff50bf4fed89\",\n _id: \"ce413e99-8469-4ed0-86e3-ff50bf4fed89\",\n shared_id: \"a876e59a-8cda-4d61-b438-c74ce7b8855d\",\n toggleState: \"visible\"\n }\n ],\n toggleState: \"visible\"\n }\n ],\n toggleState: \"visible\"\n },\n idToName: {\n ce413e99-8469-4ed0-86e3-ff50bf4fed89: \"Fouliiferous Tree H64\",\n 33fe7c13-17a4-43d6-af03-ceae6880322f: \"Fouliiferous Tree H64_2\",\n 73a41cea-4c6b-47ed-936b-3f5641aecb52: \"RootNode\"\n }\n },\n subTrees: []\n}", + "type": "json" + } + ] + }, + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to use.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/model/permissions?models=[MODELS]", + "title": "Get multiple models permissions", + "name": "getMultipleModelsPermissions", + "group": "Model", + "description": "

Gets the permissions of a list of models

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace.

" + } + ], + "Query": [ + { + "group": "Query", + "type": "String[]", + "optional": false, + "field": "MODELS", + "description": "

An array of model ids.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/models/permissions?models=5ce7dd19-1252-4548-a9c9-4a5414f2e0c5,3549ddf6-885d-4977-87f1-eeac43a0e818 HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "[\n {\n model: \"3549ddf6-885d-4977-87f1-eeac43a0e818\",\n name: \"Lego Tree\",\n permissions: [\n {\n user: \"collaboratorTeamspace1Model1JobA\",\n permission: \"collaborator\"\n },\n {\n user: \"commenterTeamspace1Model1JobA\",\n permission: \"commenter\"\n },\n {\n user: \"projectshared\"\n },\n {\n user: \"fed\"\n },\n {\n user: \"teamSpace1\"\n },\n {\n user: \"unassignedTeamspace1UserJobA\"\n },\n {\n user: \"viewerTeamspace1Model1JobA\"\n },\n {\n user: \"viewerTeamspace1Model1JobB\"\n },\n {\n user: \"commenterTeamspace1Model1JobB\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobB\"\n },\n {\n user: \"adminTeamspace1JobA\"\n },\n {\n user: \"adminTeamspace1JobB\"\n },\n {\n user: \"weirdTeamspace\"\n }\n ],\n subModels: []\n },\n {\n model: \"5ce7dd19-1252-4548-a9c9-4a5414f2e0c5\",\n federate: {\n },\n name: \"Full Logo \",\n permissions: [\n {\n user: \"viewerTeamspace1Model1JobA\",\n permission: \"viewer\"\n },\n {\n user: \"commenterTeamspace1Model1JobA\",\n permission: \"viewer\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobA\",\n permission: \"commenter\"\n },\n {\n user: \"commenterTeamspace1Model1JobB\",\n permission: \"commenter\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobB\",\n permission: \"collaborator\"\n },\n {\n user: \"projectshared\",\n permission: \"collaborator\"\n },\n {\n user: \"fed\"\n },\n {\n user: \"teamSpace1\"\n },\n {\n user: \"unassignedTeamspace1UserJobA\"\n },\n {\n user: \"viewerTeamspace1Model1JobB\"\n },\n {\n user: \"adminTeamspace1JobA\"\n },\n {\n user: \"adminTeamspace1JobB\"\n },\n {\n user: \"weirdTeamspace\"\n }\n ],\n subModels: [\n {\n database: \"teamSpace1\",\n model: \"7cf61b4f-acdf-4295-b2d0-9b45f9f27418\"\n },\n {\n database: \"teamSpace1\",\n model: \"b1fceab8-b0e9-4e45-850b-b9888efd6521\"\n }\n ]\n }\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:rev/idMap.json", + "title": "Get tree path by revision", + "name": "getRevIdMap", + "group": "Model", + "description": "

Get tree path by revision. See more details here.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to ID map for.

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

Revision to use.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:rev/idToMeshes.json", + "title": "Get ID Meshes by revision", + "name": "getRevIdToMeshes", + "group": "Model", + "description": "

Get ID Meshes by revision. See more details here.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to use.

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

Revision to use.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:rev/modelProperties.json", + "title": "Get model properties by revision", + "name": "getRevModelProperties", + "group": "Model", + "description": "

Get model properties by revision. See more details here.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to use.

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

Revision to use.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:rev/fulltree.json", + "title": "Get tree by revision", + "name": "getRevModelTree", + "group": "Model", + "description": "

Get full tree by revision. See more details here.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to get Tree for.

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

Revision to use.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:rev/srcAssets.json", + "title": "Get revision's src assets", + "name": "getRevSrcAssets", + "group": "Model", + "description": "

Get the model's assets but of a particular revision

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model Id to get unity assets for.

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

The revision of the model to get src assets for

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /Repo3DDemo/01713310-2286-11eb-93c1-296aba26cc11/revision/4d48e3de-1c87-4fdf-87bf-d92c224eb3fe/srcAssets.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n \"models\": [\n {\n \"database\": \"Repo3DDemo\",\n \"model\": \"011382b0-2286-11eb-93c1-296aba26cc11\",\n \"assets\": [\n \"153cf665-2c84-4ff9-a9e2-ba495af8e6dc\",\n \"07c67b6c-4b02-435f-8639-ea88403c36f7\",\n \"2967230f-67fa-45dc-9686-161e45c7c8a2\"\n ],\n \"offset\": [\n 9.999999999999787,\n 0,\n -9.999999999999787\n ]\n },\n {\n \"database\": \"Repo3DDemo\",\n \"model\": \"01168ff0-2286-11eb-93c1-296aba26cc11\",\n \"assets\": [\n \"89d5580a-3224-4e50-bbab-89d855c320e0\"\n ],\n \"offset\": [\n 1610,\n 740,\n -2410\n ]\n },\n {\n \"database\": \"Repo3DDemo\",\n \"model\": \"01153060-2286-11eb-93c1-296aba26cc11\",\n \"assets\": [\n \"c14dbbee-a8fd-4ed8-8641-9e24737f8238\"\n ],\n \"offset\": [\n -688.095458984375,\n 6410.9140625,\n 683.460205078125\n ]\n }\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:rev/unityAssets.json", + "title": "Get revision's unity assets", + "name": "getRevUnityAssets", + "group": "Model", + "description": "

Get the model's assets but of a particular revision

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model Id to get unity assets for.

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

The revision of the model to get unity assets for

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/revision/master/head/unityAssets.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n models: [\n {\n _id: \"Mw+Qm5J5QaqofBxG9TqOkw==\",\n assets: [\n \"/teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/92fc213b-1bab-49a4-b10e-f4368a52d500.unity3d\"\n ],\n database: \"teamSpace1\",\n model: \"3549ddf6-885d-4977-87f1-eeac43a0e818\",\n offset: [\n -688.095458984375,\n 6410.9140625,\n 683.460205078125\n ],\n jsonFiles: [\n \"/teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/92fc213b-1bab-49a4-b10e-f4368a52d500_unity.json.mpc\"\n ]\n }\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:rev/assetsMeta", + "title": "Get revision's metadata about the assets generated", + "name": "getRevUnityAssets", + "group": "Model", + "description": "

Get the model's assets metadata of a particular revision

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model Id

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

The revision of the model

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/revision/master/head/assetsMeta HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n superMeshes: [\n {\n _id: \"\",\n nVertices: 123,\n nFaces: 123,\n nUVChannels: 123,\n boundingBox: [[1, 2, 3], [3,4, 5]]\n },\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/:uid.src.mpc", + "title": "Get Model in SRC representation", + "name": "getSRC", + "group": "Model", + "description": "

Get a mesh presented in SRC format.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

id of the model

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "uid", + "description": "

id of the SRC file.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/permissions", + "title": "Get model permissions", + "name": "getSingleModelPermissions", + "group": "Model", + "description": "

Gets the permissions of a model

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to get Permission for.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/permissions HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "[\n {\n user: \"viewerTeamspace1Model1JobA\",\n permission: \"viewer\"\n },\n {\n user: \"commenterTeamspace1Model1JobA\",\n permission: \"viewer\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobA\",\n permission: \"commenter\"\n },\n {\n user: \"commenterTeamspace1Model1JobB\",\n permission: \"commenter\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobB\",\n permission: \"collaborator\"\n },\n {\n user: \"projectshared\",\n permission: \"collaborator\"\n },\n {\n user: \"fed\"\n },\n {\n user: \"teamSpace1\"\n },\n {\n user: \"unassignedTeamspace1UserJobA\"\n },\n {\n user: \"viewerTeamspace1Model1JobB\"\n },\n {\n user: \"adminTeamspace1JobA\"\n },\n {\n user: \"adminTeamspace1JobB\"\n },\n {\n user: \"weirdTeamspace\"\n }\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/srcAssets.json", + "title": "Get Src assets for the master branch", + "name": "getSrcAssets", + "group": "Model", + "description": "

Get the lastest model's version src assets

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model Id to get unity assets for.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /Repo3DDemo/01713310-2286-11eb-93c1-296aba26cc11/revision/master/head/srcAssets.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n \"models\": [\n {\n \"database\": \"Repo3DDemo\",\n \"model\": \"011382b0-2286-11eb-93c1-296aba26cc11\",\n \"assets\": [\n \"153cf665-2c84-4ff9-a9e2-ba495af8e6dc\",\n \"07c67b6c-4b02-435f-8639-ea88403c36f7\",\n \"2967230f-67fa-45dc-9686-161e45c7c8a2\"\n ],\n \"offset\": [\n 9.999999999999787,\n 0,\n -9.999999999999787\n ]\n },\n {\n \"database\": \"Repo3DDemo\",\n \"model\": \"01168ff0-2286-11eb-93c1-296aba26cc11\",\n \"assets\": [\n \"89d5580a-3224-4e50-bbab-89d855c320e0\"\n ],\n \"offset\": [\n 1610,\n 740,\n -2410\n ]\n },\n {\n \"database\": \"Repo3DDemo\",\n \"model\": \"01153060-2286-11eb-93c1-296aba26cc11\",\n \"assets\": [\n \"c14dbbee-a8fd-4ed8-8641-9e24737f8238\"\n ],\n \"offset\": [\n -688.095458984375,\n 6410.9140625,\n 683.460205078125\n ]\n }\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:revId/subModelRevisions", + "title": "Get submodel revisions by rev", + "name": "getSubModelRevisionsByRev", + "group": "Model", + "description": "

In a federation it returns the submodels revisions of a particular federation revision. See more details here

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to get properties for.

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

Revision to use.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/subModelRevisions", + "title": "Get submodels revisions", + "name": "getSubRevisionModels", + "group": "Model", + "description": "

In a federation it returns the submodels revisions of the latest federation revision.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to get properties for.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/5ce7dd19-1252-4548-a9c9-4a5414f2e0c5/revision/master/head/subModelRevisions HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n \"b1fceab8-b0e9-4e45-850b-b9888efd6521\": {\n \"name\": \"block\",\n \"revisions\": [\n {\n \"_id\": \"ddcc3213-af61-4d30-921f-e502d1c2199c\",\n \"author\": \"teamSpace1\",\n \"tag\": \"block\",\n \"timestamp\": \"2019-05-02T16:16:49.000Z\",\n \"name\": \"ddcc3213-af61-4d30-921f-e502d1c2199c\",\n \"branch\": \"master\"\n }\n ]\n },\n \"7cf61b4f-acdf-4295-b2d0-9b45f9f27418\": {\n \"name\": \"letters\",\n \"revisions\": [\n {\n \"_id\": \"a1bcfa72-ff37-41ac-95ab-66e450a37896\",\n \"author\": \"teamSpace1\",\n \"tag\": \"letters\",\n \"timestamp\": \"2019-05-02T16:16:32.000Z\",\n \"name\": \"a1bcfa72-ff37-41ac-95ab-66e450a37896\",\n \"branch\": \"master\"\n }\n ]\n },\n \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\": {\n \"name\": \"pipes\",\n \"revisions\": [\n {\n \"_id\": \"9ee1190b-cd25-4467-8d38-5af7c77cab5a\",\n \"author\": \"teamSpace1\",\n \"tag\": \"pipes\",\n \"timestamp\": \"2019-05-02T16:17:04.000Z\",\n \"name\": \"9ee1190b-cd25-4467-8d38-5af7c77cab5a\",\n \"branch\": \"master\"\n }\n ]\n }\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/tree_path.json", + "title": "Get tree paths", + "name": "getTreePath", + "group": "Model", + "description": "

Returns the full tree path for the model and if the model is a federation of it submodels. These tree paths have the path to get to every object in the model.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to get tree path for.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/5ce7dd19-1252-4548-a9c9-4a5414f2e0c5/revision/master/head/tree_path.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n mainTree: {\n idToPath: {\n d68cf5e7-4d0f-4702-8a92-c81b72928c54: \"d68cf5e7-4d0f-4702-8a92-c81b72928c54\",\n 261bf9df-64d7-4642-8bb2-0a79abd370ec: \"d68cf5e7-4d0f-4702-8a92-c81b72928c54__528c62e6-5cf8-4868-b5ff-733c128b4b4e__261bf9df-64d7-4642-8bb2-0a79abd370ec\",\n 528c62e6-5cf8-4868-b5ff-733c128b4b4e: \"d68cf5e7-4d0f-4702-8a92-c81b72928c54__528c62e6-5cf8-4868-b5ff-733c128b4b4e\",\n 7d5ce878-6ec9-4c11-a96d-12b68c9e9c7c: \"d68cf5e7-4d0f-4702-8a92-c81b72928c54__95744e20-4b4d-4fc1-8ba7-1f31ebf772b6__7d5ce878-6ec9-4c11-a96d-12b68c9e9c7c\",\n 71634e9c-da2c-4ea7-bd04-44971d3fd8dc: \"d68cf5e7-4d0f-4702-8a92-c81b72928c54__a70dd58c-c09e-4ed4-ac7e-914dbd145302__71634e9c-da2c-4ea7-bd04-44971d3fd8dc\",\n 95744e20-4b4d-4fc1-8ba7-1f31ebf772b6: \"d68cf5e7-4d0f-4702-8a92-c81b72928c54__95744e20-4b4d-4fc1-8ba7-1f31ebf772b6\",\n a70dd58c-c09e-4ed4-ac7e-914dbd145302: \"d68cf5e7-4d0f-4702-8a92-c81b72928c54__a70dd58c-c09e-4ed4-ac7e-914dbd145302\"\n }\n },\n subModels: [\n {\n account: \"teamSpace1\",\n model: \"b1fceab8-b0e9-4e45-850b-b9888efd6521\",\n idToPath: {\n a82a3b7f-bcd9-4487-8f94-370fa1f2ea4e: \"33c36fee-622d-46a5-8be1-a1bd295aa7d1__a82a3b7f-bcd9-4487-8f94-370fa1f2ea4e\",\n 33c36fee-622d-46a5-8be1-a1bd295aa7d1: \"33c36fee-622d-46a5-8be1-a1bd295aa7d1\"\n }\n },\n {\n account: \"teamSpace1\",\n model: \"7cf61b4f-acdf-4295-b2d0-9b45f9f27418\",\n idToPath: {\n 8a1f9cad-18d8-47ce-9cbd-08ba53858ced: \"ea37c2ed-39d4-4236-843c-332d52876c96__8a1f9cad-18d8-47ce-9cbd-08ba53858ced\",\n ea37c2ed-39d4-4236-843c-332d52876c96: \"ea37c2ed-39d4-4236-843c-332d52876c96\"\n }\n },\n {\n account: \"teamSpace1\",\n model: \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\",\n idToPath: {\n 8ef1c52e-8838-46dc-9825-efe46aa10041: \"3abc5450-5db8-459b-80ea-cb9fca9ccedd__8ef1c52e-8838-46dc-9825-efe46aa10041\",\n ecc25d63-87e0-4600-ae60-f38f766bc9e4: \"3abc5450-5db8-459b-80ea-cb9fca9ccedd__ecc25d63-87e0-4600-ae60-f38f766bc9e4\",\n 3abc5450-5db8-459b-80ea-cb9fca9ccedd: \"3abc5450-5db8-459b-80ea-cb9fca9ccedd\"\n }\n }\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:rev/tree_path.json", + "title": "Get tree path by revision", + "name": "getTreePathByRevision", + "group": "Model", + "description": "

Get tree path by revision. See more details here.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to get tree path for.

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

Revision to use.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/unityAssets.json", + "title": "Get unity assets", + "name": "getUnityAssets", + "group": "Model", + "description": "

Get the lastest model's version unity assets

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model Id to get unity assets for.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/revision/master/head/unityAssets.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n models: [\n {\n _id: \"Mw+Qm5J5QaqofBxG9TqOkw==\",\n assets: [\n \"/teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/92fc213b-1bab-49a4-b10e-f4368a52d500.unity3d\"\n ],\n database: \"teamSpace1\",\n model: \"3549ddf6-885d-4977-87f1-eeac43a0e818\",\n offset: [\n -688.095458984375,\n 6410.9140625,\n 683.460205078125\n ],\n jsonFiles: [\n \"/teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/92fc213b-1bab-49a4-b10e-f4368a52d500_unity.json.mpc\"\n ]\n }\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/unityAssets.json", + "title": "Get unity assets", + "name": "getUnityAssets", + "group": "Model", + "description": "

Get the lastest model's version unity assets

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model Id to get unity assets for.

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

The revision of the model

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/revision/master/head/unityAssets.json HTTP/1.1", + "type": "get" + }, + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/revision/master/head/assetsMeta HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n superMeshes: [\n {\n _id: \"\",\n nVertices: 123,\n nFaces: 123,\n nUVChannels: 123,\n boundingBox: [[1, 2, 3], [3,4, 5]]\n },\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/:uid.unity3d", + "title": "Get Unity Bundle", + "name": "getUnityBundle", + "group": "Model", + "description": "

Gets an actual unity bundle file. The path for this api is provided in the data retrieved by either one of the endpoints /:teamspace/:model/revision/master/head/unityAssets.json or /:teamspace/:model/revision/:rev/unityAssets.json

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

id of the model

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "uid", + "description": "

id of the unity bundle

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "post", + "url": "/:teamspace/:model/upload/ms-chunking", + "title": "Initialise MS chunking request", + "name": "initChunking", + "group": "Model", + "description": "

Initiate model revision data for MS Logic Apps chunked upload.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model id to upload.

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "filename", + "description": "

Filename of content to upload

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "tag", + "description": "

Tag name for new revision

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "desc", + "description": "

Description for new revision

" + }, + { + "group": "Request body", + "type": "Boolean", + "optional": true, + "field": "importAnimations", + "description": "

Whether to import animations within a sequence

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /teamSpace1/b1fceab8-b0e9-4e45-850b-b9888efd6521/upload/ms-chunking HTTP/1.1\n{\n\t\"filename\": \"structure.ifc\",\n\t\"tag\": \"rev001\",\n\t\"desc\": \"Revision 2\"\n}", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response:", + "content": "HTTP/1.1 200 OK\n{\n\t\"corID\": \"00000000-0000-1111-2222-333333333333\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/searchtree.json?searchString=[searchString]", + "title": "Search model tree", + "name": "searchModelTree", + "group": "Model", + "description": "

Searches the model (or models if it is a federation) tree and returns the objects matching their names with the searchString param.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to use.

" + } + ], + "Query": [ + { + "group": "Query", + "type": "String", + "optional": false, + "field": "searchString", + "description": "

The string to use for search tree objects

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/revision/master/head/searchtree.json?searchString=fou HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "[\n {\n \"_id\": \"33fe7c13-17a4-43d6-af03-ceae6880322f\",\n \"name\": \"Fouliiferous Tree H64_2\",\n \"account\": \"teamSpace1\",\n \"model\": \"3549ddf6-885d-4977-87f1-eeac43a0e818\"\n },\n {\n \"_id\": \"ce413e99-8469-4ed0-86e3-ff50bf4fed89\",\n \"name\": \"Fouliiferous Tree H64\",\n \"account\": \"teamSpace1\",\n \"model\": \"3549ddf6-885d-4977-87f1-eeac43a0e818\"\n }\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:rev/searchtree.json?searchString=[searchString]", + "title": "Search model tree by revision", + "name": "searchModelTreeRev", + "group": "Model", + "description": "

Searches the model (or models if it is a federation) tree and returns the objects matching their names with the searchString param. See more details here

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to use.

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

Revision to use.

" + } + ], + "Query": [ + { + "group": "Query", + "type": "String", + "optional": false, + "field": "searchString", + "description": "

The string to use for search tree objects

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "put", + "url": "/:teamspace/:model/settings/heliSpeed", + "title": "Update model heli speed", + "name": "updateHeliSpeed", + "group": "Model", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to Update Heli speed.

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "Number", + "optional": false, + "field": "heliSpeed", + "description": "

The value of the speed that will replace the heli speed.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "PUT /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/settings/heliSpeed HTTP/1.1\n{\"heliSpeed\":3}", + "type": "put" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "put", + "url": "/:teamspace/:model", + "title": "Update Federated Model", + "name": "updateModel", + "group": "Model", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Federated Model ID to update

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "[]Submodel", + "optional": false, + "field": "subModels", + "description": "

Information on the models that are going to get federated

" + } + ], + "Request body: SubModel": [ + { + "group": "Request body: SubModel", + "type": "String", + "optional": false, + "field": "database", + "description": "

The teamspace name which the model belongs to

" + }, + { + "group": "Request body: SubModel", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model id to be federated

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "PUT /teamSpace1/5ce7dd19-1252-4548-a9c9-4a5414f2e0c5 HTTP/1.1\n{\n subModels: [\n {\n database: \"teamSpace1\",\n model: \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\",\n },\n {\n database: \"teamSpace1\",\n model: \"7cf61b4f-acdf-4295-b2d0-9b45f9f27418\",\n }\n ]\n}", + "type": "put" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n account: \"teamSpace1\",\n model: \"5ce7dd19-1252-4548-a9c9-4a5414f2e0c5\",\n setting: {\n _id: \"5ce7dd19-1252-4548-a9c9-4a5414f2e0c5\",\n federate: {\n },\n desc: \"\",\n name: \"Full Logo test\",\n timestamp: \"2019-08-22T10:42:05.242Z\",\n type: \"Federation\",\n subModels: [\n {\n database: \"teamSpace1\",\n model: \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\"\n },\n {\n database: \"teamSpace1\",\n model: \"7cf61b4f-acdf-4295-b2d0-9b45f9f27418\"\n }\n ],\n surveyPoints: [\n {\n position: [\n 0,\n 0,\n 0\n ],\n latLong: [\n 0,\n 0\n ]\n }\n ],\n properties: {\n unit: \"mm\"\n },\n permissions: [\n {\n user: \"viewerTeamspace1Model1JobA\",\n permission: \"viewer\"\n },\n {\n user: \"commenterTeamspace1Model1JobA\",\n permission: \"commenter\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobA\",\n permission: \"collaborator\"\n },\n {\n user: \"commenterTeamspace1Model1JobB\",\n permission: \"commenter\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobB\",\n permission: \"collaborator\"\n }\n ],\n status: \"ok\"\n }\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "patch", + "url": "/:teamspace/:model/permissions", + "title": "Update model permissions", + "name": "updateModelPermissions", + "group": "Model", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "Permission[]", + "optional": false, + "field": "BODY", + "description": "

List of user permissions

" + } + ], + "Request body: Permission": [ + { + "group": "Request body: Permission", + "type": "string", + "optional": false, + "field": "user", + "description": "

User ID

" + }, + { + "group": "Request body: Permission", + "type": "string", + "optional": false, + "field": "permission", + "description": "

Permission type ('viewer'|'commenter'|'collaborator'|'').

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage (add user permission):", + "content": "PATCH /acme/00000000-0000-0000-0000-000000000000/permissions HTTP/1.1\n[\n {\n user: \"alice\",\n permission: \"collaborator\"\n }\n]", + "type": "patch" + }, + { + "title": "Example usage (add multiple user permissions):", + "content": "PATCH /acme/00000000-0000-0000-0000-000000000000/permissions HTTP/1.1\n[\n {\n user: \"bob\",\n permission: \"commenter\"\n },\n {\n user: \"mike\",\n permission: \"viewer\"\n }\n]", + "type": "patch" + }, + { + "title": "Example usage (remove user permission):", + "content": "PATCH /acme/00000000-0000-0000-0000-000000000000/permissions HTTP/1.1\n[\n {\n user: \"mike\",\n permission: \"\"\n }\n]", + "type": "patch" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n status: \"ok\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "post", + "url": "/:teamspace/models/permissions", + "title": "Update multiple models permissions", + "name": "updateMultiplePermissions", + "group": "Model", + "deprecated": { + "content": "use now (#Model:batchUpdateModelPermissions)" + }, + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace.

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "[]ModelPermissions", + "optional": false, + "field": "BODY", + "description": "

Its an array with a list of model ids and their permissions.

" + } + ], + "Request body: ModelPermissions": [ + { + "group": "Request body: ModelPermissions", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model id of the model that will have their permission changed. If it's a federation the entry in the response corresponding with the model will have the 'federated' field set to true.

" + }, + { + "group": "Request body: ModelPermissions", + "type": "[]Permission", + "optional": false, + "field": "permissions", + "description": "

An array indicating the new permissions.

" + } + ], + "Request body: Permission": [ + { + "group": "Request body: Permission", + "type": "string", + "optional": false, + "field": "user", + "description": "

User ID

" + }, + { + "group": "Request body: Permission", + "type": "string", + "optional": false, + "field": "permission", + "description": "

Permission type ('viewer'|'commenter'|'collaborator'|'').

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /teamSpace1/models/permissions HTTP/1.1\n[\n {\n model: \"5ce7dd19-1252-4548-a9c9-4a5414f2e0c5\",\n permissions: [\n {\n user: \"viewerTeamspace1Model1JobA\",\n permission: \"viewer\"\n },\n {\n user: \"commenterTeamspace1Model1JobA\",\n permission: \"viewer\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobA\",\n permission: \"collaborator\"\n },\n {\n user: \"commenterTeamspace1Model1JobB\",\n permission: \"commenter\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobB\",\n permission: \"collaborator\"\n }\n ]\n }\n]", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "[\n {\n name: \"Full Logo \",\n federate: true,\n model: \"5ce7dd19-1252-4548-a9c9-4a5414f2e0c5\",\n permissions: [\n {\n user: \"viewerTeamspace1Model1JobA\",\n permission: \"viewer\"\n },\n {\n user: \"commenterTeamspace1Model1JobA\",\n permission: \"viewer\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobA\",\n permission: \"collaborator\"\n },\n {\n user: \"commenterTeamspace1Model1JobB\",\n permission: \"commenter\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobB\",\n permission: \"collaborator\"\n },\n {\n user: \"projectshared\"\n },\n {\n user: \"fed\"\n },\n {\n user: \"teamSpace1\"\n },\n {\n user: \"unassignedTeamspace1UserJobA\"\n },\n {\n user: \"viewerTeamspace1Model1JobB\"\n },\n {\n user: \"adminTeamspace1JobA\"\n },\n {\n user: \"adminTeamspace1JobB\"\n },\n {\n user: \"weirdTeamspace\"\n }\n ],\n subModels: [\n {\n database: \"teamSpace1\",\n model: \"7cf61b4f-acdf-4295-b2d0-9b45f9f27418\"\n },\n {\n database: \"teamSpace1\",\n model: \"b1fceab8-b0e9-4e45-850b-b9888efd6521\"\n }\n ]\n }\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "post", + "url": "/:teamspace/:model/permissions", + "title": "Update model permissions", + "name": "updatePermissions", + "group": "Model", + "deprecated": { + "content": "use now (#Model:updateModelPermissions)" + }, + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model id of the model to be updated

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "[]Permissions", + "optional": false, + "field": "BODY", + "description": "

Its an array with a list of users and their permission type.

" + } + ], + "Request body: Permission": [ + { + "group": "Request body: Permission", + "type": "string", + "optional": false, + "field": "user", + "description": "

User ID

" + }, + { + "group": "Request body: Permission", + "type": "string", + "optional": false, + "field": "permission", + "description": "

Permission type ('viewer'|'commenter'|'collaborator'|'').

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /teamSpace1/5ce7dd19-1252-4548-a9c9-4a5414f2e0c5/permissions HTTP/1.1\n[\n {\n user: \"viewerTeamspace1Model1JobA\",\n permission: \"collaborator\"\n },\n {\n user: \"commenterTeamspace1Model1JobA\",\n permission: \"viewer\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobA\",\n permission: \"collaborator\"\n },\n {\n user: \"commenterTeamspace1Model1JobB\",\n permission: \"commenter\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobB\",\n permission: \"collaborator\"\n }\n]", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n _id: \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\",\n timestamp: \"2019-05-02T16:17:14.000Z\",\n type: \"Architectural\",\n desc: \"\",\n name: \"pipes\",\n subModels: [],\n surveyPoints: [\n {\n position: [\n 0,\n 0,\n 0\n ],\n latLong: [\n 0,\n 0\n ]\n }\n ],\n properties: {\n unit: \"mm\"\n },\n permissions: [\n {\n user: \"viewerTeamspace1Model1JobA\",\n permission: \"collaborator\"\n },\n {\n user: \"commenterTeamspace1Model1JobA\",\n permission: \"viewer\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobA\",\n permission: \"collaborator\"\n },\n {\n user: \"commenterTeamspace1Model1JobB\",\n permission: \"commenter\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobB\",\n permission: \"collaborator\"\n }\n ],\n status: \"ok\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "put", + "url": "/:teamspace/:model/settings/", + "title": "Update Model Settings", + "name": "updateSettings", + "group": "Model", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to update Settings.

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "name", + "description": "

Name of the model to be created

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "unit", + "description": "

The unit in which the model is specified

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "code", + "description": "

A code to be associated with the model; it can be of maximum 5 letters (a-z) and numbers

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "type", + "description": "

The type of the model

" + }, + { + "group": "Request body", + "type": "Number", + "optional": false, + "field": "angleFromNorth", + "description": "

GIS bearing angle

" + }, + { + "group": "Request body", + "type": "Number", + "optional": false, + "field": "elevation", + "description": "

GIS elevation

" + }, + { + "group": "Request body", + "type": "[]SurveyPoint", + "optional": false, + "field": "surveyPoints", + "description": "

an array containing GIS surveypoints

" + } + ], + "Request body: SurveyPoint": [ + { + "group": "Request body: SurveyPoint", + "type": "Number[]", + "optional": false, + "field": "position", + "description": "

an array representing a three dimensional coordinate

" + }, + { + "group": "Request body: SurveyPoint", + "type": "Number[]", + "optional": false, + "field": "latLong", + "description": "

an array representing a two dimensional coordinate for latitude and logitude

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "PUT /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/settings HTTP/1.1\n{\n name: \"Medieval\",\n unit: \"cm\",\n code: \"1233\",\n type: \"Architectural\",\n angleFromNorth: 3,\n elevation: 0,\n surveyPoints: [\n {\n position: [\n 4,\n -7,\n -1\n ],\n latLong: [\n 1,\n 2,\n ]\n }\n ]\n}", + "type": "put" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n code: \"stage\",\n unit: \"cm\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "patch", + "url": "/:teamspace/:model/upload/ms-chunking/:corID", + "title": "Upload model chunk", + "name": "uploadChunk", + "group": "Model", + "description": "

Upload model chunk for Microsoft Logic Apps.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID to upload

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "corID", + "description": "

Upload correlation ID

" + } + ], + "Request header": [ + { + "group": "Request header", + "type": "String", + "optional": false, + "field": "Content-Range", + "description": "

Byte range for the current content chunk, including the starting value, ending value, and the total content size, for example: "bytes 0-1023/10100"

" + }, + { + "group": "Request header", + "type": "String", + "optional": false, + "field": "Content-Type", + "description": "

Type of chunked content

" + }, + { + "group": "Request header", + "type": "String", + "optional": false, + "field": "Content-Length", + "description": "

Length of size in bytes of the current chunk

" + } + ], + "Request body: Attachment": [ + { + "group": "Request body: Attachment", + "type": "binary", + "optional": false, + "field": "FILE", + "description": "

the file to be uploaded

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "String", + "optional": false, + "field": "Range", + "description": "

Byte range for content that has been received by the endpoint, for example: "bytes=0-1023"

" + }, + { + "group": "200", + "type": "Number", + "optional": true, + "field": "x-ms-chunk-size", + "description": "

Suggested chunk size in bytes

" + } + ] + }, + "examples": [ + { + "title": "Success-Response:", + "content": "HTTP/1.1 200 OK\n{\n\t\"Range\": \"bytes=0-1023\",\n\t\"x-ms-chunk-size\": 1024\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "PATCH /teamSpace1/b1fceab8-b0e9-4e45-850b-b9888efd6521/upload/ms-chunking/00000000-0000-1111-2222-333333333333 HTTP/1.1\n\nheader: {\n\t\"Content-Range\": \"bytes 0-1023/10100\",\n\t\"Content-Type\": \"application/octet-stream\",\n\t\"Content-Length\": \"bytes=1024\"\n}\n\nbody: {\n\t\"file\": \n}", + "type": "patch" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "post", + "url": "/:teamspace/:model/upload/ms-chunking/:corID", + "title": "Start MS chunking upload", + "name": "uploadChunksStart", + "group": "Model", + "description": "

Start chunked model upload for Microsoft Logic Apps. Max chunk size defined as 52,428,800 bytes (52 MB) based on https://docs.microsoft.com/en-us/azure/logic-apps/logic-apps-limits-and-config?tabs=azure-portal

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID to upload

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "corID", + "description": "

Upload correlation ID

" + } + ], + "Request header": [ + { + "group": "Request header", + "type": "String", + "optional": false, + "field": "x-ms-transfer-mode", + "description": "

Indicates that the content is uploaded in chunks; value="chunked"

" + }, + { + "group": "Request header", + "type": "Number", + "optional": false, + "field": "x-ms-content-length", + "description": "

The entire content size in bytes before chunking

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "Number", + "optional": true, + "field": "x-ms-chunk-size", + "description": "

Suggested chunk size in bytes

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "Location", + "description": "

The URL location where to send the HTTP PATCH messages

" + } + ] + }, + "examples": [ + { + "title": "Success-Response:", + "content": "HTTP/1.1 200 OK\n{\n\t\"x-ms-chunk-size\": 1024,\n\t\"Location\": \"/teamSpace1/b1fceab8-b0e9-4e45-850b-b9888efd6521/upload/ms-chunking/00000000-0000-1111-2222-333333333333\"\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /teamSpace1/b1fceab8-b0e9-4e45-850b-b9888efd6521/upload/ms-chunking/00000000-0000-1111-2222-333333333333 HTTP/1.1\n\nheader: {\n\t\"x-ms-transfer-mode\": \"chunked\",\n\t\"x-ms-content-length\": 10100\n}", + "type": "post" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "post", + "url": "/:teamspace/:model/upload", + "title": "Upload Model.", + "name": "uploadModel", + "group": "Model", + "description": "

It uploads a model file and creates a new revision for that model.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model id to upload.

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "tag", + "description": "

the tag name for the new revision

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "desc", + "description": "

the description for the new revision

" + }, + { + "group": "Request body", + "type": "Boolean", + "optional": true, + "field": "importAnimations", + "description": "

whether to import animations within a sequence

" + } + ], + "Request body: Attachment": [ + { + "group": "Request body: Attachment", + "type": "binary", + "optional": false, + "field": "FILE", + "description": "

the file to be uploaded

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /teamSpace1/b1fceab8-b0e9-4e45-850b-b9888efd6521/upload HTTP/1.1\nContent-Type: multipart/form-data; boundary=----WebKitFormBoundarySos0xligf1T8Sy8I\n\n------WebKitFormBoundarySos0xligf1T8Sy8I\nContent-Disposition: form-data; name=\"file\"; filename=\"3DrepoBIM.obj\"\nContent-Type: application/octet-stream\n\n\n------WebKitFormBoundarySos0xligf1T8Sy8I\nContent-Disposition: form-data; name=\"tag\"\n\nrev1\n------WebKitFormBoundarySos0xligf1T8Sy8I\nContent-Disposition: form-data; name=\"desc\"\n\nel paso\n------WebKitFormBoundarySos0xligf1T8Sy8I-- *", + "type": "post" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "delete", + "url": "/notifications", + "title": "Delete All notification", + "name": "deleteAllNotifications", + "group": "Notification", + "version": "0.0.0", + "filename": "src/v4/routes/notification.js", + "groupTitle": "Notification" + }, + { + "type": "delete", + "url": "/notifications/:id", + "title": "Delete a notification", + "name": "deleteNotification", + "group": "Notification", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "optional": false, + "field": "id", + "description": "

Unique Notification ID

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/notification.js", + "groupTitle": "Notification" + }, + { + "type": "get", + "url": "/notifications/:id", + "title": "Get a notification", + "name": "getNotification", + "group": "Notification", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "id", + "description": "

Unique Notification ID

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/notification.js", + "groupTitle": "Notification" + }, + { + "type": "get", + "url": "/notifications", + "title": "Get all notifications", + "name": "getNotifications", + "group": "Notification", + "version": "0.0.0", + "filename": "src/v4/routes/notification.js", + "groupTitle": "Notification" + }, + { + "type": "patch", + "url": "/notifications/:id", + "title": "Patch a notification", + "name": "patchNotification", + "group": "Notification", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "id", + "description": "

Unique Notification ID

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/notification.js", + "groupTitle": "Notification" + }, + { + "type": "patch", + "url": "/notifications", + "title": "Patch all the user notifications", + "name": "patchNotification", + "group": "Notification", + "version": "0.0.0", + "filename": "src/v4/routes/notification.js", + "groupTitle": "Notification" + }, + { + "type": "get", + "url": "/:teamspace/:model/permission-templates", + "title": "List all model templates", + "name": "listModelTemplates", + "group": "PermissionTemplate", + "description": "

Get a list of model permission templates. Intended for users that have manage_model_permission privileges.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/permission-templates HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/permissionTemplate.js", + "groupTitle": "Permission Template", + "groupDescription": "

Permission template is a grouping of model level permissions. An ID is assigned to it as well. They are viewer, commenter, and collaborator.

Three default permission templates are created by default. They are viewer, commenter, and collaborator.

", + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"_id\":\"Template1\",\n\t\t\"permissions\":[\n\t\t\t\"view_model\"\n\t\t]\n\t},\n\t{\n\t\t\"_id\":\"Template2\",\n\t\t\"permissions\":[\n\t\t\t\"view_model\",\n\t\t\t\"view_issue\"\n\t\t]\n\t}\n]", + "type": "json" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/permission-templates", + "title": "Get all templates", + "name": "listTemplates", + "group": "PermissionTemplate", + "description": "

Get a list of teamspace permission templates.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/permission-templates HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/permissionTemplate.js", + "groupTitle": "Permission Template", + "groupDescription": "

Permission template is a grouping of model level permissions. An ID is assigned to it as well. They are viewer, commenter, and collaborator.

Three default permission templates are created by default. They are viewer, commenter, and collaborator.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"_id\":\"Template1\",\n\t\t\"permissions\":[\n\t\t\t\"view_model\"\n\t\t]\n\t},\n\t{\n\t\t\"_id\":\"Template2\",\n\t\t\"permissions\":[\n\t\t\t\"view_model\",\n\t\t\t\"view_issue\"\n\t\t]\n\t}\n]", + "type": "json" + } + ] + } + }, + { + "type": "get", + "url": "/plans", + "title": "List all Plans", + "name": "listPlans", + "group": "Plan", + "version": "0.0.0", + "filename": "src/v4/routes/plan.js", + "groupTitle": "Plan" + }, + { + "type": "put", + "url": "/:teamspace/:model/presentation/:code/start", + "title": "Starts a presentation session and returns the presentation code", + "name": "startPresentation", + "group": "Presentation", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

The teamspace where the presentation is taking place

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model where the presentation is taking place

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /teamSpace1/5ce7dd19-1252-4548-a9c9-4a5414f2e0c5/presentation/start HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{ code: \"aASnk\" }", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/presentation.js", + "groupTitle": "Presentation" + }, + { + "type": "put", + "url": "/:teamspace/:model/presentation/:code/start", + "title": "Starts a presentation session and returns the presentation code", + "name": "startPresentation", + "group": "Presentation", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

The teamspace where the presentation is taking place

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model where the presentation is taking place

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "code", + "description": "

The code that users need to join in order to get the viewpoint.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /teamSpace1/5ce7dd19-1252-4548-a9c9-4a5414f2e0c5/presentation/start HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{ code: \"aASnk\" }", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/presentation.js", + "groupTitle": "Presentation" + }, + { + "type": "put", + "url": "/:teamspace/:model/presentation/:code/stream", + "title": "Streams a viewpoint", + "name": "streamPresentation", + "group": "Presentation", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

The teamspace where the presentation is taking place

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model where the presentation is taking place

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "code", + "description": "

The code that users need to join in order to get the viewpoint.

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "StreamingViewpoint", + "optional": false, + "field": "The", + "description": "

viewpoint

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/presentation.js", + "groupTitle": "Presentation" + }, + { + "type": "post", + "url": "/:teamspace/projects", + "title": "Create project", + "name": "createProject", + "group": "Project", + "description": "

It creates a project. The name of the project is required.

", + "permission": [ + { + "name": "canCreateProject" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of the teamspace

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "name", + "description": "

The name of the project to be created

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /teamSpace1/projects HTTP/1.1\n{name: \"Classic project\"}", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success", + "content": "{\n name: \"Classic project\",\n _id: \"5d5bec491c15383184eb7521\",\n permissions: [\n \"create_model\",\n \"create_federation\",\n \"admin_project\",\n \"edit_project\",\n \"delete_project\",\n \"upload_files_all_models\",\n \"edit_federation_all_models\",\n \"create_issue_all_models\",\n \"comment_issue_all_models\",\n \"view_issue_all_models\",\n \"view_model_all_models\",\n \"download_model_all_models\",\n \"change_model_settings_all_models\"\n ],\n models: []\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/project.js", + "groupTitle": "Project" + }, + { + "type": "delete", + "url": "/:teamspace/projects/:project", + "title": "Delete project", + "name": "deleteProject", + "group": "Project", + "description": "

Deletes a project, including all the models and federations inside of it.

", + "permission": [ + { + "name": "canDeleteProject" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of the teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "project", + "description": "

Project to delete

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "DELETE /teamSpace1/projects/Classic%20project%20renamed HTTP/1.1", + "type": "delete" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n _id: \"5d5bec491c15383184eb7521\",\n name: \"Classic project renamed\",\n permissions: [\n {\n user: \"projectshared\",\n permissions: [\n \"admin_project\"\n ]\n }\n ],\n models: []\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/project.js", + "groupTitle": "Project" + }, + { + "type": "get", + "url": "/:teamspace/projects/:project/models", + "title": "List models of the project", + "name": "listModels", + "group": "Project", + "description": "

It returns a list of models .

", + "permission": [ + { + "name": "canListProjects" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of the teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "project", + "description": "

The name of the project to list models

" + } + ], + "Query": [ + { + "group": "Query", + "type": "String", + "optional": true, + "field": "name", + "description": "

Filters models by name

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/projects/Bim%20Logo/models?name=log HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "[\n {\n \"_id\": \"5ce7dd19-1252-4548-a9c9-4a5414f2e0c5\",\n \"federate\": true,\n \"desc\": \"\",\n \"name\": \"Full Logo\",\n \"__v\": 17,\n \"timestamp\": \"2019-05-02T16:17:37.902Z\",\n \"type\": \"Federation\",\n \"subModels\": [\n {\n \"database\": \"teamSpace1\",\n \"model\": \"b1fceab8-b0e9-4e45-850b-b9888efd6521\",\n \"name\": \"block\"\n },\n {\n \"database\": \"teamSpace1\",\n \"model\": \"7cf61b4f-acdf-4295-b2d0-9b45f9f27418\",\n \"name\": \"letters\"\n },\n {\n \"database\": \"teamSpace1\",\n \"model\": \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\",\n \"name\": \"pipes\"\n }\n ],\n \"surveyPoints\": [\n {\n \"position\": [\n 0,\n 0,\n 0\n ],\n \"latLong\": [\n -34.459127,\n 0\n ]\n }\n ],\n \"properties\": {\n \"unit\": \"mm\",\n \"topicTypes\": [\n {\n \"label\": \"Clash\",\n \"value\": \"clash\"\n },\n {\n \"label\": \"Diff\",\n \"value\": \"diff\"\n },\n {\n \"label\": \"RFI\",\n \"value\": \"rfi\"\n },\n {\n \"label\": \"Risk\",\n \"value\": \"risk\"\n },\n {\n \"label\": \"H&S\",\n \"value\": \"hs\"\n },\n {\n \"label\": \"Design\",\n \"value\": \"design\"\n },\n {\n \"label\": \"Constructibility\",\n \"value\": \"constructibility\"\n },\n {\n \"label\": \"GIS\",\n \"value\": \"gis\"\n },\n {\n \"label\": \"For information\",\n \"value\": \"for_information\"\n },\n {\n \"label\": \"VR\",\n \"value\": \"vr\"\n }\n ]\n },\n \"permissions\": [\n \"change_model_settings\",\n \"upload_files\",\n \"create_issue\",\n \"comment_issue\",\n \"view_issue\",\n \"view_model\",\n \"download_model\",\n \"edit_federation\",\n \"delete_federation\",\n \"delete_model\",\n \"manage_model_permission\"\n ],\n \"status\": \"ok\",\n \"id\": \"5ce7dd19-1252-4548-a9c9-4a5414f2e0c5\",\n \"model\": \"5ce7dd19-1252-4548-a9c9-4a5414f2e0c5\",\n \"account\": \"teamSpace1\",\n \"headRevisions\": {\n }\n }\n]\t *", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/project.js", + "groupTitle": "Project" + }, + { + "type": "get", + "url": "/:teamspace/projects/:project", + "title": "Get project", + "name": "listProject", + "group": "Project", + "description": "

Get the details of a project; name, user permissions, modelids.

", + "permission": [ + { + "name": "canViewProject" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of the teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "project", + "description": "

Project name to be queried

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/projects/Classic%20project%20renamed HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n _id: \"5d5bec491c15383184eb7521\",\n name: \"Classic project renamed\",\n permissions: [\n {\n user: \"projectshared\",\n permissions: [\n \"admin_project\"\n ]\n },\n {\n user: \"viewerTeamspace1Model1JobA\",\n permissions: []\n },\n {\n user: \"commenterTeamspace1Model1JobB\",\n permissions: []\n },\n {\n user: \"collaboratorTeamspace1Model1JobA\",\n permissions: []\n }\n ],\n models: []\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/project.js", + "groupTitle": "Project" + }, + { + "type": "get", + "url": "/:teamspace/projects", + "title": "List projects", + "name": "listProjects", + "group": "Project", + "description": "

It returns a list of projects with their permissions and model ids.

", + "permission": [ + { + "name": "canListProjects" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of the teamspace

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/projects HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "[\n {\n _id: \"5ccb1490b4626d30c05c9401\",\n name: \"Medieval\",\n permissions: [\n {\n user: \"projectshared\",\n permissions: []\n },\n {\n user: \"fed\",\n permissions: []\n },\n {\n user: \"teamSpace1\",\n permissions: []\n },\n {\n user: \"weirdTeamspace\",\n permissions: []\n }\n ],\n models: [\n \"50926a1f-1525-44ac-b6a1-d016949a13bb\"\n ]\n },\n {\n _id: \"5ccb1702b4626d30c05c9830\",\n name: \"Bim Logo\",\n permissions: [\n {\n user: \"projectshared\",\n permissions: []\n },\n {\n user: \"commenterTeamspace1Model1JobA\",\n permissions: []\n },\n {\n user: \"commenterTeamspace1Model1JobB\",\n permissions: []\n },\n {\n user: \"collaboratorTeamspace1Model1JobA\",\n permissions: []\n },\n {\n user: \"collaboratorTeamspace1Model1JobB\",\n permissions: []\n },\n {\n user: \"adminTeamspace1JobA\",\n permissions: []\n },\n {\n user: \"adminTeamspace1JobB\",\n permissions: []\n },\n {\n user: \"weirdTeamspace\",\n permissions: []\n }\n ],\n models: [\n \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\",\n \"b1fceab8-b0e9-4e45-850b-b9888efd6521\",\n \"7cf61b4f-acdf-4295-b2d0-9b45f9f27418\",\n \"5ce7dd19-1252-4548-a9c9-4a5414f2e0c5\"\n ]\n },\n {\n _id: \"5d5bec491c15383184eb7521\",\n name: \"Classic project renamed\",\n permissions: [\n {\n user: \"projectshared\",\n permissions: [\n \"admin_project\"\n ]\n },\n {\n user: \"viewerTeamspace1Model1JobA\",\n permissions: []\n },\n {\n user: \"commenterTeamspace1Model1JobB\",\n permissions: []\n },\n {\n user: \"collaboratorTeamspace1Model1JobA\",\n permissions: []\n }\n ],\n models: []\n }\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/project.js", + "groupTitle": "Project" + }, + { + "type": "patch", + "url": "/:teamspace/projects/:project", + "title": "Update project", + "name": "updateProject", + "group": "Project", + "description": "

Update project properties (name, permissions)

", + "permission": [ + { + "name": "canUpdateProject" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "project", + "description": "

Name of project

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "name", + "description": "

Project name

" + }, + { + "group": "Request body", + "type": "ProjectPermission[]", + "optional": true, + "field": "permissions", + "description": "

List of user permissions

" + } + ], + "Type: ProjectPermission": [ + { + "group": "Type: ProjectPermission", + "type": "String", + "optional": false, + "field": "user", + "description": "

Username of user

" + }, + { + "group": "Type: ProjectPermission", + "type": "String[]", + "optional": false, + "field": "permissions", + "description": "

List of user privileges

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage (update permissions):", + "content": "PATCH /acme/ProjectAnvil HTTP/1.1\n{\n permissions: [\n {\n user: \"alice\",\n permissions: [\n \"admin_project\"\n ]\n },\n {\n user: \"mike\",\n permissions: []\n }\n ]\n}", + "type": "patch" + }, + { + "title": "Example usage (rename project):", + "content": "PATCH /acme/ProjectAnvil HTTP/1.1\n{\n name: \"ProjectInstantTunnel\"\n}", + "type": "patch" + }, + { + "title": "Example usage:", + "content": "PATCH /acme/ProjectInstantTunnel HTTP/1.1\n{\n name: \"Project Trebuchet\",\n permissions: [\n {\n user: \"bob\",\n permissions: [\n \"admin_project\"\n ]\n }\n ]\n}", + "type": "patch" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response:", + "content": "{\n status: \"ok\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/project.js", + "groupTitle": "Project" + }, + { + "type": "put", + "url": "/:teamspace/projects/:project", + "title": "Update project", + "name": "updateProjectPut", + "group": "Project", + "description": "

It updates a project. The name can be changed and the permissions as well as the permissions of users

", + "deprecated": { + "content": "use now (#Project:updateProject)" + }, + "permission": [ + { + "name": "canUpdateProject" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of the teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "project", + "description": "

The name of the project to update

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "name", + "description": "

The name of the project to be created

" + }, + { + "group": "Request body", + "type": "[]Permission", + "optional": false, + "field": "permissions", + "description": "

The permissions for each user from the project

" + } + ], + "Request body: Permissions": [ + { + "group": "Request body: Permissions", + "type": "String", + "optional": false, + "field": "user", + "description": "

The username of the user to have it permission changed

" + }, + { + "group": "Request body: Permissions", + "type": "String[]", + "optional": false, + "field": "permissions", + "description": "

An array of permissions for the user to be assigned

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage update permissions:", + "content": "PUT /teamSpace1/Classic%20project HTTP/1.1\n{\n name: \"Classic project\",\n permissions: [\n {\n user: \"projectshared\",\n permissions: [\n \"admin_project\"\n ]\n },\n {\n user: \"viewerTeamspace1Model1JobA\",\n permissions: []\n },\n {\n user: \"commenterTeamspace1Model1JobB\",\n permissions: []\n },\n {\n user: \"collaboratorTeamspace1Model1JobA\",\n permissions: []\n }\n ]\n}", + "type": "put" + }, + { + "title": "Example usage rename project:", + "content": "PUT /teamSpace1/Classic%20project HTTP/1.1\n{name: \"Classic project renamed\"}", + "type": "put" + } + ], + "success": { + "examples": [ + { + "title": "Success update permissions:", + "content": "{\n _id: \"5d5bec491c15383184eb7521\",\n name: \"Classic project\",\n permissions: [\n {\n user: \"projectshared\",\n permissions: [\n \"admin_project\"\n ]\n }\n ],\n models: []\n}", + "type": "json" + }, + { + "title": "Success rename project:", + "content": "{\n _id: \"5d5bec491c15383184eb7521\",\n name: \"Classic project renamed\",\n permissions: [\n {\n user: \"projectshared\",\n permissions: [\n \"admin_project\"\n ]\n }\n ],\n models: []\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/project.js", + "groupTitle": "Project" + }, + { + "type": "get", + "url": "/:teamspace/:model/resources/:resourceId", + "title": "Get resource file", + "name": "getResource", + "group": "Resources", + "description": "

Is the URL for downloading the resource file identified by the resourceId.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "resourceId", + "description": "

The Id of the resource

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/resources.js", + "groupTitle": "Resources" + }, + { + "type": "post", + "url": "/:teamspace/:model/risks/:riskId/resources", + "title": "Attach resources to a risk", + "name": "attachResourceRisk", + "group": "Risks", + "description": "

Attaches file or URL resources to a risk. If the type of the resource is file it should be sent as multipart/form-data. Both types at the same time cannot be sent. So in order to attach files and URLs it should be done with two different requests.

This method triggers a chat event

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "riskId", + "description": "

Risk ID

" + } + ], + "Request body file resource (multipart/form-data)": [ + { + "group": "Request body file resource (multipart/form-data)", + "type": "File[]", + "optional": false, + "field": "files", + "description": "

The array of files to be attached

" + }, + { + "group": "Request body file resource (multipart/form-data)", + "type": "String[]", + "optional": false, + "field": "names", + "description": "

The names of the files; it should have the same length as the files field and should include the file extension

" + } + ], + "Request body URL resource": [ + { + "group": "Request body URL resource", + "type": "String[]", + "optional": false, + "field": "urls", + "description": "

The array of URLs to be attached

" + }, + { + "group": "Request body URL resource", + "type": "String[]", + "optional": false, + "field": "names", + "description": "

The names of the URLs; it should have the same length as the URL field

" + } + ] + } + }, + "success": { + "examples": [ + { + "title": "Success example result after two files has been uploaded", + "content": "\n[\n {\n \"_id\":\"7617f775-9eb7-4877-8ec3-98ea3457e519\",\n \"size\":1422,\n \"riskIds\":[\n \"3e8a11e0-9812-11e9-9c4d-ebde5888e062\"\n ],\n \"name\":\"todo.txt\",\n \"user\":\"teamSpace1\",\n \"createdAt\":1561973996461\n },\n {\n \"_id\":\"e25e42d5-c4f0-4fbc-a8f4-bc9899e6662a\",\n \"size\":2509356,\n \"riskIds\":[\n \"3e8a11e0-9812-11e9-9c4d-ebde5888e062\"\n ],\n \"name\":\"football.gif\",\n \"user\":\"teamSpace1\",\n \"createdAt\":1561973996462\n }\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/risk.js", + "groupTitle": "SafetiBase Risks" + }, + { + "type": "post", + "url": "/:teamspace/:model/risks/:riskId/comments", + "title": "Add a comment", + "name": "commentRisk", + "group": "Risks", + "description": "

Create a comment in a risk.

", + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "_id", + "description": "

Risk ID

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "rev_id", + "description": "

Revision ID

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "comment", + "description": "

Comment text

" + }, + { + "group": "Request body", + "type": "Viewpoint", + "optional": false, + "field": "viewpoint", + "description": "

Viewpoint object

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "riskId", + "description": "

Risk ID

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "guid", + "description": "

Comment ID

" + }, + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "created", + "description": "

Comment creation timestamp

" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "owner", + "description": "

Comment owner

" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "comment", + "description": "

Comment text

" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "viewpoint", + "description": "

Viewpoint object

" + } + ] + }, + "examples": [ + { + "title": "Success-Response.", + "content": "HTTP/1.1 200 OK\n{\n\t\"guid\":\"00000000-0000-0000-0000-000000000007\",\n\t\"created\":1567172228143,\n\t\"owner\":\"alice\",\n\t\"comment\":\"Comment 1\",\n\t\"viewpoint\":{\n\t\t\"right\":[0.5,-0.1,0.5],\n\t\t\"up\":[0.3,0.9,-0.3],\n\t\t\"position\":[-50000.0,100000.0,150000.0],\n\t\t\"look_at\":[35000.0,50000.0,9000.0],\n\t\t\"view_dir\":[0.5,-0.5,-1.0],\n\t\t\"near\":500.0,\n\t\t\"far\":300000,\n\t\t\"fov\":1.05,\n\t\t\"aspect_ratio\":1.5,\n\t\t\"clippingPlanes\":[],\n\t\t\"screenshot\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/viewpoints/00000000-0000-0000-0000-000000000005/screenshot.png\",\n\t\t\"guid\":\"00000000-0000-0000-0000-000000000006\",\n\t\t\"screenshotSmall\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/viewpoints/00000000-0000-0000-0000-000000000005/screenshotSmall.png\"\n\t}\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/comments HTTP/1.1\n{\n\t\"_id\":\"00000000-0000-0000-0000-000000000002\",\n\t\"rev_id\":\"00000000-0000-0000-0000-000000000001\",\n\t\"comment\":\"Comment 1\",\n\t\"viewpoint\":{\n\t\t\"right\":[0.5,-0.1,0.5],\n\t\t\"up\":[0.3,0.9,-0.3],\n\t\t\"position\":[-50000.0,100000.0,150000.0],\n\t\t\"look_at\":[35000.0,50000.0,9000.0],\n\t\t\"view_dir\":[0.5,-0.5,-1.0],\n\t\t\"near\":500.0,\n\t\t\"far\":300000,\n\t\t\"fov\":1.05,\n\t\t\"aspect_ratio\":1.5,\n\t\t\"clippingPlanes\":[],\n\t\t\"highlighted_group_id\":\"\",\n\t\t\"screenshot\":\n\t}\n}", + "type": "post" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/risk.js", + "groupTitle": "SafetiBase Risks" + }, + { + "type": "delete", + "url": "/:teamspace/:model/risks/:riskId/comments", + "title": "Delete a comment", + "name": "deleteComment", + "group": "Risks", + "description": "

Delete a risk comment.

", + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "guid", + "description": "

Comment ID

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "riskId", + "description": "

Risk ID

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "DELETE /acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/comments HTTP/1.1\n{\n\t\"guid\":\"00000000-0000-0000-0000-000000000007\",\n}", + "type": "delete" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response.", + "content": "HTTP/1.1 200 OK\n{\n\t\"guid\":\"00000000-0000-0000-0000-000000000007\",\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/risk.js", + "groupTitle": "SafetiBase Risks" + }, + { + "type": "delete", + "url": "/:teamspace/:model/risks/:riskId/resources", + "title": "Detach a resource from a risk", + "name": "detachResourceRisk", + "group": "Risks", + "description": "

Detachs a resource from a risk. If the risk is the last entity the resources has been attached to it also deletes the resource from the system. This method triggers a chat event .

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "riskId", + "description": "

Risk ID

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "_id", + "description": "

The resource id to be detached

" + } + ] + } + }, + "success": { + "examples": [ + { + "title": "{", + "content": "\n{\n \"_id\":\"e25e42d5-c4f0-4fbc-a8f4-bc9899e6662a\",\n \"size\":2509356,\n \"riskIds\":[\n ],\n \"name\":\"football.gif\",\n \"user\":\"teamSpace1\",\n \"createdAt\":1561973996462\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/risk.js", + "groupTitle": "SafetiBase Risks" + }, + { + "type": "get", + "url": "/:teamspace/mitigations/criteria", + "title": "Get mitigation criteria", + "name": "findMitigationCriteria", + "group": "Risks", + "description": "

Returns all mitigations criteria from mitigation suggestions.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/mitigations/criteria HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response.", + "content": "HTTP/1.1 200 OK\n{\n\t\"associated_activity\":[\n\t\t\"All construction\",\n\t\t\"Site tests\",\n\t\t\"Logistics\"\n\t],\n\t\"category\":[\n\t\t\"safety_electricity\"\n\t],\n\t\"element\":[\n\t\t\"Doors\",\n\t\t\"Floors\",\n\t\t\"Pipes\",\n\t\t\"Vents\",\n\t\t\"Walls\"\n\t],\n\t\"location_desc\":[\n\t\t\"Tower 1 - Level 0\",\n\t\t\"Tower 1 - Level 1\",\n\t\t\"Tower 1 - Level 2\",\n\t\t\"Tower 2 - Level 0\",\n\t\t\"Tower 2 - Level 1\",\n\t\t\"Tower 3 - Level 0\",\n\t\t\"Tower 3 - Level 1\",\n\t\t\"Tower 3 - Level 2\"\n\t],\n\t\"mitigation_stage\":[\n\t\t\"Preliminary Design\",\n\t\t\"Detail Design\",\n\t\t\"Preconstruction\",\n\t\t\"Site work and Change Control\"\n\t],\n\t\"mitigation_type\":[\n\t\t\"Eliminate\",\n\t\t\"Reduce\",\n\t\t\"Control\",\n\t\t\"Inform\"\n\t],\n\t\"risk_factor\":[\n\t\t\"Factor 2\",\n\t\t\"Factor 5\",\n\t\t\"Factor 8\"\n\t],\n\t\"scope\":[\n\t\t\"General concrete\",\n\t\t\"In situ concrete\"\n\t]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/mitigation.js", + "groupTitle": "SafetiBase Risks" + }, + { + "type": "post", + "url": "/:teamspace/mitigations", + "title": "Find mitigation suggestions", + "name": "findMitigationSuggestions", + "group": "Risks", + "description": "

Returns a list of suggestions for risk mitigation based on given criteria.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "associated_activity", + "description": "

Risk associated activity

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "category", + "description": "

Risk category

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "element", + "description": "

Risk element type

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "location_desc", + "description": "

Risk location description

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "risk_factor", + "description": "

Risk factor

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "scope", + "description": "

Risk construction scope

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /acme/mitigations HTTP/1.1\n{\n\t\"associated_activity\":\"\",\n\t\"category\":\"safety_fall\",\n\t\"element\":\"Doors\",\n\t\"location_desc\":\"Tower 3 - Level 2\",\n\t\"risk_factor\":\"Factor 9\",\n\t\"scope\":\"Tower 3\"\n}", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response.", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"mitigation_desc\":\"Replace all openings required in floor slabs with precast service openings.\",\n\t\t\"mitigation_detail\":\"Replace openings larger than a standard anvil required in floor slabs with precast service openings from A/W 2020 catalogue.\",\n\t\t\"mitigation_stage\":\"Preliminary Design\",\n\t\t\"mitigation_type\":\"Eliminate\"\n\t},\n\t{\n\t\t\"mitigation_desc\":\"Provide safe walking surface joint covers. Any covering should be: strong enough to support any loads likely to be placed on it ; and fixed in position to prevent accidental dislodgement.\",\n\t\t\"mitigation_detail\":\"Safe walking surface joint covers for all joins and gaps. Covers should be strong enough to support any loads likely to be placed on it and fixed in position with bolts to prevent accidental dislodgement.\",\n\t\t\"mitigation_stage\":\"Detail Design\",\n\t\t\"mitigation_type\":\"Reduce\"\n\t},\n\t{\n\t\t\"mitigation_desc\":\"Provide warning markings and/or colour change.\",\n\t\t\"mitigation_detail\":\"Provide warning markings from approved list of markings and/or colour change using chart from Document XYZ.\",\n\t\t\"mitigation_stage\":\"Preconstruction\",\n\t\t\"mitigation_type\":\"Control\"\n\t}\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/mitigation.js", + "groupTitle": "SafetiBase Risks" + }, + { + "type": "get", + "url": "/:teamspace/:model/risks/:riskId", + "title": "Get a risk", + "name": "findRiskById", + "group": "Risks", + "description": "

Retrieve a risk. The response includes all comments and screenshot URLs.

", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "risk", + "description": "

The Issue matching the Issue ID

" + } + ] + }, + "examples": [ + { + "title": "Success-Response.", + "content": "HTTP/1.1 200 OK\n{\n\t\"_id\":\"00000000-0000-0000-0000-000000000002\",\n\t\"account\":\"acme\",\n\t\"assigned_roles\":[\n\t\t\"Job1\"\n\t],\n\t\"associated_activity\":\"Column casting\",\n\t\"category\":\"safety_fall\",\n\t\"comments\":[],\n\t\"consequence\":0,\n\t\"created\":1567156228976,\n\t\"creator_role\":\"Job4\",\n\t\"desc\":\"Risk description that describes the risk\",\n\t\"element\":\"Doors\",\n\t\"level_of_risk\":0,\n\t\"likelihood\":0,\n\t\"location_desc\":\"Tower 3 - Level 2\",\n\t\"mitigation_desc\":\"Erect temporary barrier\",\n\t\"mitigation_detail\":\"Erect a temporary 1.5m metal barrier along edge\",\n\t\"mitigation_stage\":\"Construction stage 5\",\n\t\"mitigation_status\":\"proposed\",\n\t\"mitigation_type\":\"Eliminate\",\n\t\"model\":\"00000000-0000-0000-0000-000000000000\",\n\t\"name\":\"Risk 1\",\n\t\"overall_level_of_risk\":0,\n\t\"owner\":\"alice\",\n\t\"position\":[55000.0,80000.0,-10000.0],\n\t\"residual_consequence\":-1,\n\t\"residual_level_of_risk\":-1,\n\t\"residual_likelihood\":-1,\n\t\"residual_risk\":\"\",\n\t\"rev_id\":\"00000000-0000-0000-0000-000000000001\",\n\t\"risk_factor\":\"Factor 9\",\n\t\"safetibase_id\":\"\",\n\t\"scope\":\"Tower 3\",\n\t\"thumbnail\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/thumbnail.png\",\n\t\"viewpoint\":{\n\t\t\"aspect_ratio\":1.4,\n\t\t\"clippingPlanes\":[],\n\t\t\"far\":300000,\n\t\t\"fov\":1.05,\n\t\t\"guid\":\"00000000-0000-0000-0000-000000000004\",\n\t\t\"hideIfc\":true,\n\t\t\"look_at\":[35000.0,40000.0,8000.0],\n\t\t\"near\":600.0,\n\t\t\"position\":[-70000.0,120000.0,150000.0],\n\t\t\"right\":[0.8,-0.3,0.6],\n\t\t\"screenshot\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/viewpoints/00000000-0000-0000-0000-000000000003/screenshot.png\",\n\t\t\"screenshotSmall\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/viewpoints/00000000-0000-0000-0000-000000000003/screenshotSmall.png\",\n\t\t\"up\":[0.3,0.9,-0.3],\n\t\t\"view_dir\":[0.5,-0.4,-0.7]\n\t}\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002 HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/risk.js", + "groupTitle": "SafetiBase Risks", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "riskId", + "description": "

Risk ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/risks/:riskId/screenshot.png", + "title": "Get risk screenshot", + "name": "getScreenshot", + "group": "Risks", + "description": "

Retrieve a risk screenshot image.

", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Screenshot image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/screenshot.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/risk.js", + "groupTitle": "SafetiBase Risks", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "riskId", + "description": "

Risk ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/risks/:riskId/screenshotSmall.png", + "title": "Get low-res screenshot", + "name": "getScreenshotSmall", + "group": "Risks", + "description": "

Retrieve a low-resolution risk screenshot image.

", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Small screenshot image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/screenshotSmall.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/risk.js", + "groupTitle": "SafetiBase Risks", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "riskId", + "description": "

Risk ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/risks/:riskId/thumbnail.png", + "title": "Get risk thumbnail", + "name": "getThumbnail", + "group": "Risks", + "description": "

Retrieve a risk thumbnail image.

", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Thumbnail image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/thumbnail.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/risk.js", + "groupTitle": "SafetiBase Risks", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "riskId", + "description": "

Risk ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model[/revision/:revId]/risks", + "title": "List all risks", + "name": "listRisks", + "group": "Risks", + "description": "

Retrieve all model risks.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "revId", + "description": "

Revision ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "updatedSince", + "description": "

Only return issues that has been updated since this value (in epoch value)

" + }, + { + "group": "Query", + "type": "Number[]", + "optional": true, + "field": "numbers", + "description": "

Array of issue numbers to filter for

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "ids", + "description": "

Array of issue ids to filter for

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "categories", + "description": "

Array of categories to filter for

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "mitigationStatus", + "description": "

Array of mitigation status to filter for

" + }, + { + "group": "Query", + "type": "Number[]", + "optional": true, + "field": "likelihoods", + "description": "

Array of likelihoods to filter for. The possible number values for this fields are UNSET: -1, VERY_LOW: 0, LOW: 1, MODERATE: 2, HIGH: 3, VERY_HIGH: 4 .

" + }, + { + "group": "Query", + "type": "Number[]", + "optional": true, + "field": "consequences", + "description": "

Array of consequences to filter for. The possible number values for this fields are UNSET: -1, VERY_LOW: 0, LOW: 1, MODERATE: 2, HIGH: 3, VERY_HIGH: 4 .

" + }, + { + "group": "Query", + "type": "Number[]", + "optional": true, + "field": "residualLikelihoods", + "description": "

Array of residual likelihoods to filter for. The possible number values for this fields are UNSET: -1, VERY_LOW: 0, LOW: 1, MODERATE: 2, HIGH: 3, VERY_HIGH: 4 .

" + }, + { + "group": "Query", + "type": "Number[]", + "optional": true, + "field": "levelOfRisks", + "description": "

Array of levels of risks to filter for. The possible number values for this fields are UNSET: -1, VERY_LOW: 0, LOW: 1, MODERATE: 2, HIGH: 3, VERY_HIGH: 4 .

" + }, + { + "group": "Query", + "type": "Number[]", + "optional": true, + "field": "residualConsequences", + "description": "

Array of residual consequences to filter for. The possible number values for this fields are UNSET: -1, VERY_LOW: 0, LOW: 1, MODERATE: 2, HIGH: 3, VERY_HIGH: 4 .

" + }, + { + "group": "Query", + "type": "Number[]", + "optional": true, + "field": "residualLevelOfRisks", + "description": "

Array of levels of risks to filter for. The possible number values for this fields are UNSET: -1, VERY_LOW: 0, LOW: 1, MODERATE: 2, HIGH: 3, VERY_HIGH: 4 .

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "Object[]", + "optional": false, + "field": "risks", + "description": "

Risk objects

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"_id\":\"00000000-0000-0000-0000-000000000002\",\n\t\t\"account\":\"acme\",\n\t\t\"assigned_roles\":[\n\t\t\t\"Job1\"\n\t\t],\n\t\t\"associated_activity\":\"Column casting\",\n\t\t\"category\":\"safety_fall\",\n\t\t\"comments\":[],\n\t\t\"consequence\":0,\n\t\t\"created\":1567156228976,\n\t\t\"creator_role\":\"Job4\",\n\t\t\"desc\":\"Risk description that describes the risk\",\n\t\t\"element\":\"Doors\",\n\t\t\"level_of_risk\":0,\n\t\t\"likelihood\":0,\n\t\t\"location_desc\":\"Tower 3 - Level 2\",\n\t\t\"mitigation_desc\":\"Erect temporary barrier\",\n\t\t\"mitigation_detail\":\"Erect a temporary 1.5m metal barrier along edge\",\n\t\t\"mitigation_stage\":\"Construction stage 5\",\n\t\t\"mitigation_status\":\"proposed\",\n\t\t\"mitigation_type\":\"Eliminate\",\n\t\t\"model\":\"00000000-0000-0000-0000-000000000000\",\n\t\t\"name\":\"Risk 1\",\n\t\t\"overall_level_of_risk\":0,\n\t\t\"owner\":\"alice\",\n\t\t\"position\":[55000.0,80000.0,-10000.0],\n\t\t\"residual_consequence\":-1,\n\t\t\"residual_level_of_risk\":-1,\n\t\t\"residual_likelihood\":-1,\n\t\t\"residual_risk\":\"\",\n\t\t\"rev_id\":\"00000000-0000-0000-0000-000000000001\",\n\t\t\"risk_factor\":\"Factor 9\",\n\t\t\"safetibase_id\":\"\",\n\t\t\"scope\":\"Tower 3\",\n\t\t\"thumbnail\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/thumbnail.png\",\n\t\t\"viewpoint\":{\n\t\t\t\"aspect_ratio\":1.4,\n\t\t\t\"clippingPlanes\":[],\n\t\t\t\"far\":300000,\n\t\t\t\"fov\":1.05,\n\t\t\t\"guid\":\"00000000-0000-0000-0000-000000000004\",\n\t\t\t\"hideIfc\":true,\n\t\t\t\"look_at\":[35000.0,40000.0,8000.0],\n\t\t\t\"near\":600.0,\n\t\t\t\"position\":[-70000.0,120000.0,150000.0],\n\t\t\t\"right\":[0.8,-0.3,0.6],\n\t\t\t\"screenshot\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/viewpoints/00000000-0000-0000-0000-000000000003/screenshot.png\",\n\t\t\t\"screenshotSmall\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/viewpoints/00000000-0000-0000-0000-000000000003/screenshotSmall.png\",\n\t\t\t\"up\":[0.3,0.9,-0.3],\n\t\t\t\"view_dir\":[0.5,-0.4,-0.7]\n\t\t}\n\t}\n]", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/risks HTTP/1.1", + "type": "get" + }, + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/revision/00000000-0000-0000-0000-000000000001/risks HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/risk.js", + "groupTitle": "SafetiBase Risks" + }, + { + "type": "get", + "url": "/:teamspace/:model[/revision/:revId]/risks.html", + "title": "Render risks as HTML", + "name": "renderRisksHTML", + "group": "Risks", + "description": "

Retrieve HTML page of all risks.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "revId", + "description": "

Revision ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Query": [ + { + "group": "Query", + "type": "String", + "optional": false, + "field": "ids", + "description": "

Risk IDs to show

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "Object[]", + "optional": false, + "field": "risks", + "description": "

Risk objects

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "html" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/risks.html?[query] HTTP/1.1", + "type": "get" + }, + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/revision/00000000-0000-0000-0000-000000000001/risks.html?[query] HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/risk.js", + "groupTitle": "SafetiBase Risks" + }, + { + "type": "post", + "url": "/:teamspace/:model[/revision/:revId]/risks", + "title": "Create a risk", + "name": "storeRisk", + "group": "Risks", + "description": "

Create a model risk.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "revId", + "description": "

Revision ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "name", + "description": "

Risk name

" + }, + { + "group": "Request body", + "type": "String[]", + "optional": false, + "field": "assigned_roles", + "description": "

Risk owner

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "associated_activity", + "description": "

Associated activity

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "category", + "description": "

Category

" + }, + { + "group": "Request body", + "type": "Number", + "optional": false, + "field": "consequence", + "description": "

Risk consequence (0: very low, 1: low, 2: moderate, 3: high, 4: very high)

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "desc", + "description": "

Risk description

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "element", + "description": "

Element type

" + }, + { + "group": "Request body", + "type": "Number", + "optional": false, + "field": "likelihood", + "description": "

Risk likelihood (0: very low, 1: low, 2: moderate, 3: high, 4: very high)

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "location_desc", + "description": "

Location description

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "mitigation_status", + "description": "

Treatment status

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "mitigation_desc", + "description": "

Treatment summary

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "mitigation_detail", + "description": "

Treatment detailed description

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "mitigation_stage", + "description": "

Treatment stage

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "mitigation_type", + "description": "

Treatment type

" + }, + { + "group": "Request body", + "type": "Number[3]", + "optional": false, + "field": "position", + "description": "

Risk pin coordinates

" + }, + { + "group": "Request body", + "type": "Number", + "optional": false, + "field": "residual_consequence", + "description": "

Treated risk consequence (-1: unset, 0: very low, 1: low, 2: moderate, 3: high, 4: very high)

" + }, + { + "group": "Request body", + "type": "Number", + "optional": false, + "field": "residual_likelihood", + "description": "

Treated risk likelihood (-1: unset, 0: very low, 1: low, 2: moderate, 3: high, 4: very high)

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "residual_risk", + "description": "

Residual risk

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "risk_factor", + "description": "

Risk factor

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "scope", + "description": "

Construction scope

" + }, + { + "group": "Request body", + "type": "Viewpoint", + "optional": false, + "field": "viewpoint", + "description": "

Viewpoint

" + } + ], + "Type: Viewpoint": [ + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "right", + "description": "

Right vector of viewpoint indicating the direction of right in relative coordinates

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "up", + "description": "

Up vector of viewpoint indicating the direction of up in relative coordinates

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "position", + "description": "

Position vector indicates where in the world the viewpoint is positioned

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "look_at", + "description": "

Vector indicating where in the world the viewpoint is looking at

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "view_dir", + "description": "

Vector indicating the direction the viewpoint is looking at in relative coordinates

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "near", + "description": "

Vector indicating the near plane

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "far", + "description": "

Vector indicating the far plane

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "fov", + "description": "

Angle of the field of view

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "aspect_ratio", + "description": "

Aspect ratio of the fustrum

" + }, + { + "group": "Type: Viewpoint", + "type": "ClippingPlane[]", + "optional": true, + "field": "clippingPlanes", + "description": "

Clipping planes associated with the viewpoint

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": true, + "field": "highlighted_group_id", + "description": "

If the viewpoint is associated with one or more highlighted objects from the model this field has the value of a group ID generated to hold those objects

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": true, + "field": "hidden_group_id", + "description": "

If the viewpoint is associated with one or more hidden objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": true, + "field": "shown_group_id", + "description": "

If the viewpoint is associated with one or more shown objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: Viewpoint", + "type": "Group", + "optional": true, + "field": "highlighted_group", + "description": "

If the viewpoint is associated with one or more highlighted objects from the model this field has the value of a group definition for those objects (this shouldnt be use simultaneously with highlighted_group_id)

" + }, + { + "group": "Type: Viewpoint", + "type": "Group", + "optional": true, + "field": "hidden_group", + "description": "

If the viewpoint is associated with one or more hidden objects from the model this field has the value of a group id generated to hold those objects (this shouldnt be use simultaneously with hidden_group_id)

" + }, + { + "group": "Type: Viewpoint", + "type": "Group", + "optional": true, + "field": "shown_group", + "description": "

If the viewpoint is associated with one or more shown objects from the model this field has the definition of the group to hold those objects (this shouldnt be use simultaneously with shown_group_id)

" + }, + { + "group": "Type: Viewpoint", + "type": "Group[]", + "optional": true, + "field": "override_groups", + "description": "

If the viewpoint has one or more objects with colour override this field has an array of groups with one group for each colour

" + }, + { + "group": "Type: Viewpoint", + "type": "Group[]", + "optional": true, + "field": "transformation_groups", + "description": "

List of groups with transformations

" + }, + { + "group": "Type: Viewpoint", + "type": "String[]", + "optional": true, + "field": "transformation_group_ids", + "description": "

List of group IDs with transformations

" + }, + { + "group": "Type: Viewpoint", + "type": "Boolean", + "optional": false, + "field": "hide_IFC", + "description": "

A flag to hide the IFC

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": false, + "field": "screenshot", + "description": "

Base64 string representing the screenshot associated with the viewpoint

" + } + ], + "Type: Group": [ + { + "group": "Type: Group", + "type": "Number[3]", + "optional": false, + "field": "color", + "description": "

RGB colour values

" + }, + { + "group": "Type: Group", + "type": "ModelObjects", + "optional": false, + "field": "objects", + "description": "

List of objects in group

" + } + ], + "Type: ModelObjects": [ + { + "group": "Type: ModelObjects", + "type": "String", + "optional": false, + "field": "account", + "description": "

The account that has the model which contains the objects

" + }, + { + "group": "Type: ModelObjects", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model id that contains the objects

" + }, + { + "group": "Type: ModelObjects", + "type": "String[]", + "optional": false, + "field": "shared_ids", + "description": "

The shared ids of objects to be selected

" + } + ], + "Type: ClippingPlane": [ + { + "group": "Type: ClippingPlane", + "type": "Number[3]", + "optional": false, + "field": "normal", + "description": "

The normal of the plane defined for the clipping plane

" + }, + { + "group": "Type: ClippingPlane", + "type": "Number", + "optional": false, + "field": "distance", + "description": "

The distance for the clipping plane to the origin

" + }, + { + "group": "Type: ClippingPlane", + "type": "Number", + "optional": false, + "field": "clipDirection", + "description": "

The direction to the clipping plane will cut the model; above or below the plane. Possible values: 1 , -1.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /acme/00000000-0000-0000-0000-000000000000/risks HTTP/1.1\n{\n\t\"assigned_roles\":[\n\t\t\"Job1\"\n\t],\n\t\"associated_activity\":\"\",\n\t\"category\":\"safety_fall\",\n\t\"comments\":[],\n\t\"consequence\":0,\n\t\"creator_role\":\"Job4\",\n\t\"desc\":\"Risk description that describes the risk\",\n\t\"element\":\"Doors\",\n\t\"level_of_risk\":0,\n\t\"likelihood\":0,\n\t\"location_desc\":\"Tower 3 - Level 2\",\n\t\"mitigation_desc\":\"Erect temporary barrier\",\n\t\"mitigation_detail\":\"Erect a temporary 1.5m metal barrier along edge\",\n\t\"mitigation_stage\":\"Construction stage 5\",\n\t\"mitigation_status\":\"proposed\",\n\t\"mitigation_type\":\"Eliminate\",\n\t\"name\":\"Risk 1\",\n\t\"overall_level_of_risk\":0,\n\t\"position\":[55000.0,80000.0,-10000.0],\n\t\"residual_consequence\":-1,\n\t\"residual_level_of_risk\":-1,\n\t\"residual_likelihood\":-1,\n\t\"residual_risk\":\"\",\n\t\"risk_factor\":\"Factor 9\",\n\t\"safetibase_id\":\"\",\n\t\"scope\":\"Tower 3\",\n\t\"viewpoint\":{\n\t\t\"aspect_ratio\":1.4,\n\t\t\"clippingPlanes\":[],\n\t\t\"far\":300000,\n\t\t\"fov\":1.05,\n\t\t\"hideIfc\":true,\n\t\t\"highlighted_group_id\":\"\",\n\t\t\"look_at\":[35000.0,40000.0,8000.0],\n\t\t\"near\":600.0,\n\t\t\"position\":[-70000.0,120000.0,150000.0],\n\t\t\"right\":[0.8,-0.3,0.6],\n\t\t\"up\":[0.3,0.9,-0.3],\n\t\t\"view_dir\":[0.5,-0.4,-0.7],\n\t\t\"screenshot\":\n\t}\n}", + "type": "post" + }, + { + "title": "Example usage:", + "content": "POST /acme/00000000-0000-0000-0000-000000000000/revision/00000000-0000-0000-0000-000000000001/risks HTTP/1.1\n{\n\t\"assigned_roles\":[\n\t\t\"Job1\"\n\t],\n\t\"associated_activity\":\"\",\n\t\"category\":\"safety_fall\",\n\t\"comments\":[],\n\t\"consequence\":0,\n\t\"creator_role\":\"Job4\",\n\t\"desc\":\"Risk description that describes the risk\",\n\t\"element\":\"Doors\",\n\t\"level_of_risk\":0,\n\t\"likelihood\":0,\n\t\"location_desc\":\"Tower 3 - Level 2\",\n\t\"mitigation_desc\":\"Erect temporary barrier\",\n\t\"mitigation_detail\":\"Erect a temporary 1.5m metal barrier along edge\",\n\t\"mitigation_stage\":\"Construction stage 5\",\n\t\"mitigation_status\":\"proposed\",\n\t\"mitigation_type\":\"Eliminate\",\n\t\"name\":\"Risk 1\",\n\t\"overall_level_of_risk\":0,\n\t\"position\":[55000.0,80000.0,-10000.0],\n\t\"residual_consequence\":-1,\n\t\"residual_level_of_risk\":-1,\n\t\"residual_likelihood\":-1,\n\t\"residual_risk\":\"\",\n\t\"risk_factor\":\"Factor 9\",\n\t\"safetibase_id\":\"\",\n\t\"scope\":\"Tower 3\",\n\t\"viewpoint\":{\n\t\t\"aspect_ratio\":1.4,\n\t\t\"clippingPlanes\":[],\n\t\t\"far\":300000,\n\t\t\"fov\":1.05,\n\t\t\"hideIfc\":true,\n\t\t\"highlighted_group_id\":\"\",\n\t\t\"look_at\":[35000.0,40000.0,8000.0],\n\t\t\"near\":600.0,\n\t\t\"position\":[-70000.0,120000.0,150000.0],\n\t\t\"right\":[0.8,-0.3,0.6],\n\t\t\"up\":[0.3,0.9,-0.3],\n\t\t\"view_dir\":[0.5,-0.4,-0.7],\n\t\t\"screenshot\":\n\t}\n}", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"_id\":\"00000000-0000-0000-0000-000000000002\",\n\t\"account\":\"acme\",\n\t\"assigned_roles\":[\n\t\t\"Job1\"\n\t],\n\t\"associated_activity\":\"\",\n\t\"category\":\"safety_fall\",\n\t\"comments\":[],\n\t\"consequence\":0,\n\t\"created\":1567156228976,\n\t\"creator_role\":\"Job4\",\n\t\"desc\":\"Risk description that describes the risk\",\n\t\"element\":\"Doors\",\n\t\"level_of_risk\":0,\n\t\"likelihood\":0,\n\t\"location_desc\":\"Tower 3 - Level 2\",\n\t\"mitigation_desc\":\"Erect temporary barrier\",\n\t\"mitigation_detail\":\"Erect a temporary 1.5m metal barrier along edge\",\n\t\"mitigation_stage\":\"Construction stage 5\",\n\t\"mitigation_status\":\"proposed\",\n\t\"mitigation_type\":\"Eliminate\",\n\t\"model\":\"00000000-0000-0000-0000-000000000000\",\n\t\"name\":\"Risk 1\",\n\t\"overall_level_of_risk\":0,\n\t\"owner\":\"alice\",\n\t\"position\":[55000.0,80000.0,-10000.0],\n\t\"residual_consequence\":-1,\n\t\"residual_level_of_risk\":-1,\n\t\"residual_likelihood\":-1,\n\t\"residual_risk\":\"\",\n\t\"rev_id\":\"00000000-0000-0000-0000-000000000001\",\n\t\"risk_factor\":\"Factor 9\",\n\t\"safetibase_id\":\"\",\n\t\"scope\":\"Tower 3\",\n\t\"thumbnail\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/thumbnail.png\",\n\t\"viewpoint\":{\n\t\t\"aspect_ratio\":1.4,\n\t\t\"clippingPlanes\":[],\n\t\t\"far\":300000,\n\t\t\"fov\":1.05,\n\t\t\"guid\":\"00000000-0000-0000-0000-000000000004\",\n\t\t\"hideIfc\":true,\n\t\t\"look_at\":[35000.0,40000.0,8000.0],\n\t\t\"near\":600.0,\n\t\t\"position\":[-70000.0,120000.0,150000.0],\n\t\t\"right\":[0.8,-0.3,0.6],\n\t\t\"screenshot\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/viewpoints/00000000-0000-0000-0000-000000000003/screenshot.png\",\n\t\t\"screenshotSmall\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/viewpoints/00000000-0000-0000-0000-000000000003/screenshotSmall.png\",\n\t\t\"up\":[0.3,0.9,-0.3],\n\t\t\"view_dir\":[0.5,-0.4,-0.7]\n\t}\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/risk.js", + "groupTitle": "SafetiBase Risks" + }, + { + "type": "patch", + "url": "/:teamspace/:model[/revision/:revId]/risks/:riskId", + "title": "Update risk", + "name": "updateRisk", + "group": "Risks", + "description": "

Update model risk.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "revId", + "description": "

Revision ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "riskId", + "description": "

Risk ID

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "name", + "description": "

Risk name

" + }, + { + "group": "Request body", + "type": "String[]", + "optional": false, + "field": "assigned_roles", + "description": "

Risk owner

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "associated_activity", + "description": "

Associated activity

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "category", + "description": "

Category

" + }, + { + "group": "Request body", + "type": "Number", + "optional": false, + "field": "consequence", + "description": "

Risk consequence (0: very low, 1: low, 2: moderate, 3: high, 4: very high)

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "desc", + "description": "

Risk description

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "element", + "description": "

Element type

" + }, + { + "group": "Request body", + "type": "Number", + "optional": false, + "field": "likelihood", + "description": "

Risk likelihood (0: very low, 1: low, 2: moderate, 3: high, 4: very high)

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "location_desc", + "description": "

Location description

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "mitigation_status", + "description": "

Treatment status

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "mitigation_desc", + "description": "

Treatment summary

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "mitigation_detail", + "description": "

Treatment detailed description

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "mitigation_stage", + "description": "

Treatment stage

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "mitigation_type", + "description": "

Treatment type

" + }, + { + "group": "Request body", + "type": "Number[3]", + "optional": false, + "field": "position", + "description": "

Risk pin coordinates

" + }, + { + "group": "Request body", + "type": "Number", + "optional": false, + "field": "residual_consequence", + "description": "

Treated risk consequence (-1: unset, 0: very low, 1: low, 2: moderate, 3: high, 4: very high)

" + }, + { + "group": "Request body", + "type": "Number", + "optional": false, + "field": "residual_likelihood", + "description": "

Treated risk likelihood (-1: unset, 0: very low, 1: low, 2: moderate, 3: high, 4: very high)

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "residual_risk", + "description": "

Residual risk

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "risk_factor", + "description": "

Risk factor

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "scope", + "description": "

Construction scope

" + }, + { + "group": "Request body", + "type": "Viewpoint", + "optional": false, + "field": "viewpoint", + "description": "

Viewpoint

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "PATCH /acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002 HTTP/1.1\n{\n\t\"residual_likelihood\":1\n}", + "type": "patch" + }, + { + "title": "Example usage:", + "content": "PATCH /acme/00000000-0000-0000-0000-000000000000/revision/00000000-0000-0000-0000-000000000001/risks/00000000-0000-0000-0000-000000000002 HTTP/1.1\n{\n\t\"residual_likelihood\":1\n}", + "type": "patch" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"_id\":\"00000000-0000-0000-0000-000000000002\",\n\t\"account\":\"acme\",\n\t\"assigned_roles\":[\n\t\t\"Job1\"\n\t],\n\t\"associated_activity\":\"\",\n\t\"category\":\"safety_fall\",\n\t\"comments\":[],\n\t\"consequence\":0,\n\t\"created\":1567156228976,\n\t\"creator_role\":\"Job4\",\n\t\"desc\":\"Risk description that describes the risk\",\n\t\"element\":\"Doors\",\n\t\"level_of_risk\":0,\n\t\"likelihood\":0,\n\t\"location_desc\":\"Tower 3 - Level 2\",\n\t\"mitigation_desc\":\"Erect temporary barrier\",\n\t\"mitigation_detail\":\"Erect a temporary 1.5m metal barrier along edge\",\n\t\"mitigation_stage\":\"Construction stage 5\",\n\t\"mitigation_status\":\"proposed\",\n\t\"mitigation_type\":\"Eliminate\",\n\t\"model\":\"00000000-0000-0000-0000-000000000000\",\n\t\"name\":\"Risk 1\",\n\t\"owner\":\"alice\",\n\t\"overall_level_of_risk\":0,\n\t\"position\":[55000.0,80000.0,-10000.0],\n\t\"residual_consequence\":-1,\n\t\"residual_level_of_risk\":-1,\n\t\"residual_likelihood\":1,\n\t\"residual_risk\":\"\",\n\t\"rev_id\":\"00000000-0000-0000-0000-000000000001\",\n\t\"risk_factor\":\"Factor 9\",\n\t\"safetibase_id\":\"\",\n\t\"scope\":\"Tower 3\",\n\t\"thumbnail\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/thumbnail.png\",\n\t\"viewpoint\":{\n\t\t\"aspect_ratio\":1.4,\n\t\t\"clippingPlanes\":[],\n\t\t\"far\":300000,\n\t\t\"fov\":1.05,\n\t\t\"guid\":\"00000000-0000-0000-0000-000000000004\",\n\t\t\"hideIfc\":true,\n\t\t\"look_at\":[35000.0,40000.0,8000.0],\n\t\t\"near\":600.0,\n\t\t\"position\":[-70000.0,120000.0,150000.0],\n\t\t\"right\":[0.8,-0.3,0.6],\n\t\t\"screenshot\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/viewpoints/00000000-0000-0000-0000-000000000003/screenshot.png\",\n\t\t\"screenshotSmall\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/viewpoints/00000000-0000-0000-0000-000000000003/screenshotSmall.png\",\n\t\t\"up\":[0.3,0.9,-0.3],\n\t\t\"view_dir\":[0.5,-0.4,-0.7]\n\t}\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/risk.js", + "groupTitle": "SafetiBase Risks" + }, + { + "type": "post", + "url": "/:teamspace/:model/sequences", + "title": "Create custom sequence", + "name": "createSequence", + "group": "Sequences", + "description": "

Create custom sequence for model.

", + "examples": [ + { + "title": "Example usage", + "content": "POST /acme/00000000-0000-0000-0000-000000000000/sequences HTTP/1.1\n{\n\t\"name\":\"Custom Sequence 1\",\n\t\"frames\":[\n\t\t{\n\t\t\t\"dateTime\":1244246400000,\n\t\t\t\"viewpoint\":{\n\t\t\t\t\"override_groups\":[\n\t\t\t\t\t{\n\t\t\t\t\t\t\"color\":[\n\t\t\t\t\t\t\t0,\n\t\t\t\t\t\t\t255,\n\t\t\t\t\t\t\t0\n\t\t\t\t\t\t],\n\t\t\t\t\t\t\"rules\":[\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"field\":\"IFC GUID\",\n\t\t\t\t\t\t\t\t\"operator\":\"IS\",\n\t\t\t\t\t\t\t\t\"values\":[\n\t\t\t\t\t\t\t\t\t\"0h79Q0rcfC1gOPK50yoFCv\",\n\t\t\t\t\t\t\t\t\t\"0K5o7g755EZw2RjNI7HcYK\",\n\t\t\t\t\t\t\t\t\t\"0yuGDtpaPCSBT7QB7wvN5I\",\n\t\t\t\t\t\t\t\t\t\"2HBVtaIWv07ud53r01WB6q\"\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t],\n\t\t\t\t\t\t\"account\":\"acme\",\n\t\t\t\t\t\t\"model\":\"00000000-0000-0000-0000-000000000000\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"hidden_group\":{\n\t\t\t\t\t\"rules\":[\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"field\":\"IFC GUID\",\n\t\t\t\t\t\t\t\"operator\":\"IS\",\n\t\t\t\t\t\t\t\"values\":[\n\t\t\t\t\t\t\t\t\"2S2omCydz5b9jSgrcLLblk\",\n\t\t\t\t\t\t\t\t\"0_U7q0Dzj6DfPp4VzMmTUt\",\n\t\t\t\t\t\t\t\t\"0iMv$JxRL67v6DoyA3RRwz\",\n\t\t\t\t\t\t\t\t\"1W4yiIKW92qAUdezi70DTY\",\n\t\t\t\t\t\t\t\t\"00ojKm$5f7luRCAjta0hsu\",\n\t\t\t\t\t\t\t\t\"0d2LnELub06glJ9mZh2up$\",\n\t\t\t\t\t\t\t\t\"37gui3POjDQgmIadjhr$ek\",\n\t\t\t\t\t\t\t\t\"3XAjSwznb6PfZG9t_wAFXi\"\n\t\t\t\t\t\t\t]\n\t\t\t\t\t\t}\n\t\t\t\t\t],\n\t\t\t\t\t\"account\":\"acme\",\n\t\t\t\t\t\"model\":\"00000000-0000-0000-0000-000000000000\"\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"dateTime\":1244246500000,\n\t\t\t\"viewpoint\":{\n\t\t\t\t\"up\":[0,1,0],\n\t\t\t\t\"position\":[38,38 ,125.080119148101],\n\t\t\t\t\"look_at\":[0,0,-163.080119148101],\n\t\t\t\t\"view_dir\":[0,0,-1],\n\t\t\t\t\"right\":[1,0,0],\n\t\t\t\t\"fov\":2.11248306530104,\n\t\t\t\t\"aspect_ratio\":0.875018933732738,\n\t\t\t\t\"far\":276.756120771945,\n\t\t\t\t\"near\":76.4241101223321\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"dateTime\":1244246700000,\n\t\t\t\"viewpoint\":{\n\t\t\t\t\"override_groups\":[\n\t\t\t\t\t{\n\t\t\t\t\t\t\"color\":[\n\t\t\t\t\t\t\t0,\n\t\t\t\t\t\t\t255,\n\t\t\t\t\t\t\t0\n\t\t\t\t\t\t],\n\t\t\t\t\t\t\"rules\":[\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"field\":\"IFC GUID\",\n\t\t\t\t\t\t\t\t\"operator\":\"IS\",\n\t\t\t\t\t\t\t\t\"values\":[\n\t\t\t\t\t\t\t\t\t\"00ojKm$5f7luRCAjta0hsu\"\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t],\n\t\t\t\t\t\t\"account\":\"acme\",\n\t\t\t\t\t\t\"model\":\"00000000-0000-0000-0000-000000000000\"\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"dateTime\":1244419200000,\n\t\t\t\"viewId\":\"00000000-0000-0001-0001-000000000001\"\n\t\t},\n\t\t{\n\t\t\t\"dateTime\":1244458200000,\n\t\t\t\"viewId\":\"00000000-0000-0001-0001-000000000002\"\n\t\t},\n\t\t{\n\t\t\t\"dateTime\":1244484300000,\n\t\t\t\"viewpoint\": {}\n\t\t}\n\t]\n}", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"_id\":\"00000000-0000-0000-0000-000000000002\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + } + }, + { + "type": "post", + "url": "/:teamspace/:model/sequences/:sequenceId/activities", + "title": "Create one or more activities", + "name": "createSequenceActivities", + "group": "Sequences", + "description": "

Creates a sequence activity tree.

", + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "Activity[]", + "optional": false, + "field": "activity", + "description": "

An array of the activity tree that will be created

" + }, + { + "group": "Request body", + "type": "Boolean", + "optional": true, + "field": "overwrite", + "description": "

This flag indicates whether the request will replace the currently stored activities or just added at the end of the currently stored activities array. If not present it will be considered as false.

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "sequenceId", + "description": "

Sequence unique ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Type: Activity": [ + { + "group": "Type: Activity", + "type": "String", + "optional": false, + "field": "name", + "description": "

The name of the activity

" + }, + { + "group": "Type: Activity", + "type": "Number", + "optional": false, + "field": "startDate", + "description": "

The starting timestamp date of the activity

" + }, + { + "group": "Type: Activity", + "type": "Number", + "optional": false, + "field": "endDate", + "description": "

The ending timestamp date of the activity

" + }, + { + "group": "Type: Activity", + "type": "Object", + "optional": true, + "field": "resources", + "description": "

The resources asoociated with the activity

" + }, + { + "group": "Type: Activity", + "type": "KeyValue[]", + "optional": true, + "field": "data", + "description": "

An array of key value pairs with metadata for the activity

" + }, + { + "group": "Type: Activity", + "type": "Activity[]", + "optional": true, + "field": "subActivities", + "description": "

An array of activities that will be children of the activity

" + } + ], + "Type: KeyValue": [ + { + "group": "Type: KeyValue", + "type": "String", + "optional": false, + "field": "key", + "description": "

The key of the pair

" + }, + { + "group": "Type: KeyValue", + "type": "Any", + "optional": false, + "field": "value", + "description": "

The value of the pair

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage", + "content": "POST /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0001-000000000001/activities HTTP/1.1\n{\n \"overwrite\": true,\n \"activities\": [\n {\n \"name\": \"Clinic Construction\",\n \"startDate\": 1603184400000,\n \"endDate\": 1613062800000,\n \"data\": [\n {\n \"key\": \"Color\",\n \"value\": \"green\"\n }\n ],\n \"subActivities\": [\n {\n \"name\": \"Site Work & Logistics\",\n \"startDate\": 1603184400000,\n \"endDate\": 1613062800000,\n \"data\": [\n {\n \"key\": \"Height\",\n \"value\": 12\n }\n ],\n \"subActivities\": [\n {\n \"name\": \"Site Office Installation\",\n \"startDate\": 1603184400000,\n \"endDate\": 1603213200000,\n \"data\": [\n {\n \"key\": \"Size\",\n \"value\": \"Big\"\n }\n ]\n },\n {\n \"name\": \"Excavation\",\n \"startDate\": 1603270800000,\n \"endDate\": 1603299600000\n }\n ]\n }\n ]\n }\n ]\n}", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences" + }, + { + "type": "delete", + "url": "/:teamspace/:model/sequences/:sequenceID/legend", + "title": "Delete legend", + "name": "deleteLegend", + "group": "Sequences", + "description": "

Delete the legend associated to this sequence

", + "examples": [ + { + "title": "Example usage", + "content": "DELETE /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0000-000000000002/legend HTTP/1.1", + "type": "delete" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + } + }, + { + "type": "delete", + "url": "/:teamspace/:model/sequences/:sequenceID", + "title": "Delete sequence", + "name": "deleteSequence", + "group": "Sequences", + "description": "

Delete the custom sequence by ID

", + "examples": [ + { + "title": "Example usage", + "content": "DELETE /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0000-000000000002 HTTP/1.1", + "type": "delete" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + } + }, + { + "type": "delete", + "url": "/:teamspace/:model/sequences/:sequenceId/activities/:activityId", + "title": "Edit an activity", + "name": "deleteSequenceActivity", + "group": "Sequences", + "description": "

Delete a sequence activity.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "sequenceId", + "description": "

Sequence unique ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "activityId", + "description": "

The activity unique ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage", + "content": "DELETE /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0001-000000000001/activities/fe94be44-5cd8-4aaf-b020-afc1456680d3 HTTP/1.1", + "type": "delete" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences" + }, + { + "type": "put", + "url": "/:teamspace/:model/sequences/:sequenceId/activities/:activityId", + "title": "Edit an activity", + "name": "editSequenceActivity", + "group": "Sequences", + "description": "

Edits a sequence activity.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "sequenceId", + "description": "

Sequence unique ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "activityId", + "description": "

The activity unique ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "name", + "description": "

The name of the activity

" + }, + { + "group": "Request body", + "type": "Number", + "optional": true, + "field": "startDate", + "description": "

The starting timestamp date of the activity

" + }, + { + "group": "Request body", + "type": "Number", + "optional": true, + "field": "endDate", + "description": "

The ending timestamp date of the activity

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "parent", + "description": "

The parent id if it has one. This parent must exist previously

" + }, + { + "group": "Request body", + "type": "Object", + "optional": true, + "field": "resources", + "description": "

The resources asoociated with the activity

" + }, + { + "group": "Request body", + "type": "KeyValue[]", + "optional": true, + "field": "data", + "description": "

An array of key value pairs with metadata for the activity

" + } + ], + "Type: KeyValue": [ + { + "group": "Type: KeyValue", + "type": "String", + "optional": false, + "field": "key", + "description": "

The key of the pair

" + }, + { + "group": "Type: KeyValue", + "type": "Any", + "optional": false, + "field": "value", + "description": "

The value of the pair

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage", + "content": "PATCH /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0001-000000000001/activities/fe94be44-5cd8-4aaf-b020-afc1456680d3 HTTP/1.1\n{\n \"name\":\"Renamed activity\"\n}", + "type": "patch" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences" + }, + { + "type": "get", + "url": "/:teamspace/:model/sequences/:sequenceID/legend", + "title": "get the legend", + "name": "getLegend", + "group": "Sequences", + "description": "

Get the legend for this sequence

", + "examples": [ + { + "title": "Example usage", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0000-000000000002/legend HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t \"Building works\": \"#aabbcc\"\n\t \"Temporary works\": \"#ffffff66\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/sequences/:sequenceID", + "title": "Get sequence", + "name": "getSequence", + "group": "Sequences", + "description": "

Get sequence by ID

", + "examples": [ + { + "title": "GET /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0000-000000000002 HTTP/1.1", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0000-000000000002 HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"teamspace\":\"alice\",\n\t\"model\":\"00000000-0000-0000-0000-000000000000\",\n\t\"rev_id\":\"00000000-0000-0000-0000-000000000001\",\n\t\"name\":\"Sequence 1\",\n\t\"frames\":[\n\t\t{\n\t\t\t\"dateTime\":1244246400000,\n\t\t\t\"state\":\"00000000-0000-0000-0001-000000000002\"\n\t\t},\n\t\t{\n\t\t\t\"dateTime\":1244419200000,\n\t\t\t\"state\":\"00000000-0000-0000-0002-000000000002\"\n\t\t}\n\t],\n\t\"_id\":\"00000000-0000-0000-0000-000000000002\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/sequences/:sequenceId/activities", + "title": "Get all activities", + "name": "getSequenceActivities", + "group": "Sequences", + "description": "

Get all sequence activities.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "sequenceId", + "description": "

Sequence unique ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0001-000000000001/activities HTTP/1.1\n*", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"activities\":[\n\t\t{\n\t\t\t\"id\":\"00000000-0000-0001-0001-000000000001\",\n\t\t\t\"name\":\"Construction\",\n\t\t\t\"startDate\":1244246400000,\n\t\t\t\"endDate\":1244246450000,\n\t\t\t\"subActivities\":[\n\t\t\t\t{\n\t\t\t\t\t\"id\":\"00000000-0001-0001-0001-000000000001\",\n\t\t\t\t\t\"name\":\"Prepare site\",\n\t\t\t\t\t\"startDate\":1244246400000,\n\t\t\t\t\t\"endDate\":1244246430000,\n\t\t\t\t\t\"subActivities\":[\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"id\":\"00000001-0001-0001-0001-000000000001\",\n\t\t\t\t\t\t\t\"name\":\"Erect site hoarding\",\n\t\t\t\t\t\t\t\"startDate\":1244246400000,\n\t\t\t\t\t\t\t\"endDate\":1244246410000\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"id\":\"00000002-0001-0001-0001-000000000001\",\n\t\t\t\t\t\t\t\"name\":\"Clear existing structures\",\n\t\t\t\t\t\t\t\"startDate\":1244246410000,\n\t\t\t\t\t\t\t\"endDate\":1244246420000\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"id\":\"00000003-0001-0001-0001-000000000001\",\n\t\t\t\t\t\t\t\"name\":\"Smooth work surfaces\",\n\t\t\t\t\t\t\t\"startDate\":1244246420000,\n\t\t\t\t\t\t\t\"endDate\":1244246430000\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"id\":\"00000001-0002-0001-0001-000000000001\",\n\t\t\t\t\t\"name\":\"Construct tunnel\",\n\t\t\t\t\t\"startDate\":1244246430000,\n\t\t\t\t\t\"endDate\":1244246450000,\n\t\t\t\t\t\"subActivities\":[\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"id\":\"00000001-0002-0001-0001-000000000001\",\n\t\t\t\t\t\t\t\"name\":\"Deploy instant tunnel\",\n\t\t\t\t\t\t\t\"startDate\":1244246430000,\n\t\t\t\t\t\t\t\"endDate\":1244246440000\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"id\":\"00000002-0002-0001-0001-000000000001\",\n\t\t\t\t\t\t\t\"name\":\"Add road markings\",\n\t\t\t\t\t\t\t\"startDate\":1244246440000,\n\t\t\t\t\t\t\t\"endDate\":1244246450000\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences" + }, + { + "type": "get", + "url": "/:teamspace/:model/sequences/:sequenceId/activities/:activityId", + "title": "Get activity", + "name": "getSequenceActivityDetail", + "group": "Sequences", + "description": "

Get sequence activity details.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "sequenceId", + "description": "

Sequence ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "activityId", + "description": "

Activity ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0001-000000000001/activities/00000000-0000-0002-0001-000000000001 HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n \"id\":\"00000000-0000-0002-0001-000000000001\",\n \"name\":\"Construct tunnel\",\n \"sequenceId\": \"00000000-0000-0000-0001-000000000001\",\n \"parent\": \"00000130-2300-0002-0001-000567000001\"\n \"startDate\": 1610000000000,\n \"endDate\": 1615483938124,\n \"data\":[\n {\"key\":\"Name\",\"value\":\"Construction\"},\n {\"key\":\"Status\",\"value\":\"Planned\"},\n {\"key\":\"Is Compound Task\",\"value\":\"Yes\"},\n {\"key\":\"Code\",\"value\":\"ST00020\"},\n {\"key\":\"Planned Start\",\"value\":\"15 Apr 2020 10:00:00\"},\n {\"key\":\"Type\",\"value\":\"Work\"},\n {\"key\":\"Constraint\",\"value\":\"No Constraint\"},\n {\"key\":\"Planned Finish\",\"value\":\"11 Sep 2020 18:00:00\"},\n {\"key\":\"Percentage Complete\",\"value\":0},\n {\"key\":\"Physical Volume Unity\",\"value\":\"Unknown\"},\n {\"key\":\"Estimated Rate\",\"value\":0},\n {\"key\":\"Planned Physical Volume\",\"value\":6.6},\n {\"key\":\"Actual Physical Volume\",\"value\":0.9},\n {\"key\":\"Remaining Physical Volume\",\"value\":5.7},\n {\"key\":\"Budgeted Cost\",\"value\":30},\n {\"key\":\"Actual Cost\",\"value\":9999.99}\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences" + }, + { + "type": "get", + "url": "/:teamspace/:model/sequences/:sequenceId/state/:stateId", + "title": "Get state", + "name": "getSequenceState", + "group": "Sequences", + "description": "

Get state of model in sequence.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "sequenceId", + "description": "

Sequence unique ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "stateId", + "description": "

State unique ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0001-000000000001/state/00000000-0000-0000-0001-000000000002 HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"transparency\":[\n\t\t{\n\t\t\t\"value\":1,\n\t\t\t\"shared_ids\":[\n\t\t\t\t11111111-1111-1111-1111-111111111111,\n\t\t\t\t22222222-2222-2222-2222-222222222222,\n\t\t\t\t33333333-3333-3333-3333-333333333333\n\t\t\t]\n\t\t}\n\t],\n\t\"color\":[\n\t\t{\n\t\t\t\"value\":[\n\t\t\t\t0,\n\t\t\t\t1,\n\t\t\t\t0\n\t\t\t],\n\t\t\t\"shared_ids\":[\n\t\t\t\t44444444-4444-4444-4444-444444444444,\n\t\t\t\t55555555-5555-5555-5555-555555555555,\n\t\t\t\t66666666-6666-6666-6666-666666666666\n\t\t\t]\n\t\t}\n\t],\n\t\"transform\":[\n\t\t{\n\t\t\t\"value\":[\n\t\t\t\t1, 0, 0, -0.0036411285400390625,\n\t\t\t\t0, 1, 0, 0.0012891292572021484,\n\t\t\t\t0, 0, 1, 0,\n\t\t\t\t0, 0, 0, 1\n\t\t\t],\n\t\t\t\"shared_ids\":[\n\t\t\t\t77777777-7777-7777-7777-777777777777,\n\t\t\t\t88888888-8888-8888-8888-888888888888,\n\t\t\t\t99999999-9999-9999-9999-999999999999\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"value\":[\n\t\t\t\t1, 0, 0, -0.0036411285400390625,\n\t\t\t\t0, 1, 0, 0.0012891292572021484,\n\t\t\t\t0, 0, 1, 0,\n\t\t\t\t0, 0, 0, 1\n\t\t\t],\n\t\t\t\"shared_ids\":[\n\t\t\t\t66666666-6666-6666-6666-666666666666\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"value\":[\n\t\t\t\t1, 0, 0, -0.0036411285400390625,\n\t\t\t\t0, 1, 0, 0.0012891292572021484,\n\t\t\t\t0, 0, 1, 0,\n\t\t\t\t0, 0, 0, 1\n\t\t\t],\n\t\t\t\"shared_ids\":[\n\t\t\t\t44444444-4444-4444-4444-444444444444,\n\t\t\t\taaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa,\n\t\t\t\tbbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb,\n\t\t\t\tcccccccc-cccc-cccc-cccc-cccccccccccc\n\t\t\t]\n\t\t}\n\t]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences" + }, + { + "type": "get", + "url": "/:teamspace/:model/sequences", + "title": "List all sequences", + "name": "listSequences", + "group": "Sequences", + "description": "

List all sequences associated with the model.

", + "parameter": { + "fields": { + "Query": [ + { + "group": "Query", + "type": "String", + "optional": true, + "field": "rev_id", + "description": "

Revision unique ID

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/sequences HTTP/1.1", + "type": "get" + }, + { + "title": "Example usage (with revision)", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/sequences?rev_id=00000000-0000-0000-0000-000000000001 HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"teamspace\":\"alice\",\n\t\t\"model\":\"00000000-0000-0000-0000-000000000000\",\n\t\t\"rev_id\":\"00000000-0000-0000-0000-000000000001\",\n\t\t\"name\":\"Sequence 1\",\n\t\t\"frames\":[\n\t\t\t{\n\t\t\t\t\"dateTime\":1244246400000,\n\t\t\t\t\"state\":\"00000000-0000-0000-0001-000000000002\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"dateTime\":1244419200000,\n\t\t\t\t\"state\":\"00000000-0000-0000-0002-000000000002\"\n\t\t\t}\n\t\t],\n\t\t\"_id\":\"00000000-0000-0000-0000-000000000002\"\n\t}\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences" + }, + { + "type": "put", + "url": "/:teamspace/:model/sequences/:sequenceID/legend", + "title": "Add/Update legend", + "name": "updateLegend", + "group": "Sequences", + "description": "

Update/add a legend to this sequence

", + "examples": [ + { + "title": "Example usage", + "content": "PUT /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0000-000000000002/legend HTTP/1.1", + "type": "put" + }, + { + "title": "Example usage:", + "content": "{\n\t \"Building works\": \"#aabbcc\"\n\t \"Temporary works\": \"#ffffff66\"\n}", + "type": "put" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + } + }, + { + "type": "patch", + "url": "/:teamspace/:model/sequences/:sequenceID", + "title": "Update a sequence", + "name": "updateSequence", + "group": "Sequences", + "description": "

Update a sequence (note: currently only name chance is supported

", + "examples": [ + { + "title": "Example usage", + "content": "PATCH /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0000-000000000002 HTTP/1.1", + "type": "patch" + }, + { + "title": "Example usage:", + "content": "{\n\t \"name\": \"Building works\"\n}", + "type": "patch" + } + ], + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "name", + "description": "

The new name of the sequence

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences" + }, + { + "type": "get", + "url": "/:teamspace/subscriptions", + "title": "List subscriptions", + "name": "listSubscriptions", + "group": "Subscription", + "description": "

List all subscriptions for current user if applicable.

", + "permission": [ + { + "name": "teamSpaceAdmin" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/subscriptions HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n basic: {\n collaborators: 0,\n data: 200\n },\n discretionary: {\n collaborators: \"unlimited\",\n data: 10240,\n expiryDate: null\n }\n}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "401": [ + { + "group": "401", + "optional": false, + "field": "NOT_AUTHORIZED", + "description": "

Not Authorized

" + } + ] + }, + "examples": [ + { + "title": "Error-Response", + "content": "HTTP/1.1 401 Not Authorized\n{\n\t\"message\":\"Not Authorized\",\n\t\"status\":401,\"code\":\n\t\"NOT_AUTHORIZED\",\n\t\"value\":9,\n\t\"place\":\"GET /teamSpace1/subscriptions\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/subscriptions.js", + "groupTitle": "Subscription" + }, + { + "type": "post", + "url": "/:teamspace/members", + "title": "Add a team member", + "name": "addTeamMember", + "group": "Teamspace", + "description": "

Adds a user to a teamspace and assign it a job.

", + "permission": [ + { + "name": "teamSpaceAdmin" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "job", + "description": "

The job that the users going to have assigned

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "user", + "description": "

The username of the user to become a member

" + }, + { + "group": "Request body", + "type": "String[]", + "optional": false, + "field": "permissions", + "description": "

The permisions to be assigned to the member it can be an empty array or have a "teamspace_admin" value.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /teamSpace1/members HTTP/1.1\n{\n job: \"jobA\",\n user: \"projectshared\",\n permissions: []\n}", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success", + "content": "{\n job: \"jobA\",\n permissions: [],\n user: \"projectshared\",\n firstName: \"Drink\",\n lastName: \"Coffee\",\n company: null\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/teamspace.js", + "groupTitle": "Teamspace" + }, + { + "type": "get", + "url": "/:teamspace/members/search/:searchString", + "title": "Search for non-members", + "name": "findUsersWithoutMembership", + "group": "Teamspace", + "description": "

It returns a list of users that dont belong to the teamspace and that their usernames matches partially with the string and if entered an email it only matches if the string is the entire email address.

In the result it's included their username, first name, last name, company and roles in other teamspaces.

", + "permission": [ + { + "name": "teamSpaceAdmin" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "search", + "description": "

Search string provided to find member

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/members/search/project HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success", + "content": "HTTP/1.1 200 OK\n\n[\n {\n user: \"projectowner\",\n roles: [\n {\n role: \"team_member\",\n db: \"projectowner\"\n }\n ],\n firstName: \"Project\",\n lastName: \"Owner\",\n company: null\n },\n {\n user: \"projectshared\",\n roles: [\n {\n role: \"team_member\",\n db: \"projectshared\"\n }\n ],\n firstName: \"Drink\",\n lastName: \"Coffee\",\n company: null\n },\n {\n user: \"project_username\",\n roles: [\n {\n role: \"team_member\",\n db: \"project_username\"\n }\n ],\n firstName: \"George\",\n lastName: \"Crown\",\n company: null\n },\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/teamspace.js", + "groupTitle": "Teamspace" + }, + { + "type": "get", + "url": "/:teamspace/addOns", + "title": "get enabled add ons", + "name": "getAddOns", + "group": "Teamspace", + "description": "

view the list of addOns enabled on this teamspace

", + "permission": [ + { + "name": "teamspace member" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "success": { + "examples": [ + { + "title": "Success", + "content": "{\n vrEnabled: true,\n hereEnabled: true\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/teamspace.js", + "groupTitle": "Teamspace" + }, + { + "type": "get", + "url": "/:teamspace/billingInfo", + "title": "Get billing info", + "name": "getBillingInfo", + "group": "Teamspace", + "description": "

It returns the teamspace billing info.

", + "permission": [ + { + "name": "teamSpaceAdmin" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/billingInfo HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success", + "content": "HTTP/1.1 200 OK\n{\n vat: \"GB 365684514\",\n line1: \"10 Downing Street\",\n postalCode: \"SW1A 2AA\",\n city: \"London\",\n company: \"Teamspace one\",\n countryCode: \"GB\",\n lastName: \"Voorhees\",\n firstName: \"Jason\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/teamspace.js", + "groupTitle": "Teamspace" + }, + { + "type": "get", + "url": "/:teamspace/members/:user", + "title": "Get member's info", + "name": "getMemberInfo", + "group": "Teamspace", + "description": "

It returns the teamspace's member small info .

", + "permission": [ + { + "name": "teamSpaceMember" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user", + "description": "

The username of the user you wish to query

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/members/viewerTeamspace1Model1JobB HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success", + "content": "HTTP/1.1 200 OK\n{\n user: \"viewerTeamspace1Model1JobB\",\n firstName: \"Alice\",\n lastName: \"Stratford\",\n company: \"Teamspace one\",\n job: {\"_id\": \"Job1\", color: \"#FFFFFF\"}\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/teamspace.js", + "groupTitle": "Teamspace" + }, + { + "type": "get", + "url": "/:teamspace/members", + "title": "Get members list", + "name": "getMemberList", + "group": "Teamspace", + "description": "

It returns a list of members identifying which of them are teamspace administrators, and their jobs.

", + "permission": [ + { + "name": "teamSpaceMember" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/members HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success", + "content": "HTTP/1.1 200 OK\n{\n members: [\n {\n user: \"teamSpace1\",\n firstName: \"Teamspace\",\n lastName: \"One\",\n company: \"Teamspace one\",\n permissions: [\n \"teamspace_admin\"\n ],\n job: \"jobA\",\n isCurrentUser: true\n },\n {\n user: \"unassignedTeamspace1UserJobA\",\n firstName: \"John\",\n lastName: \"Williams\",\n company: \"Teamspace One\",\n permissions: [],\n job: \"jobA\",\n isCurrentUser: false\n },\n {\n user: \"viewerTeamspace1Model1JobB\",\n firstName: \"Alice\",\n lastName: \"Stratford\",\n company: \"Teamspace one\",\n permissions: [],\n job: \"jobB\",\n isCurrentUser: false\n }\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/teamspace.js", + "groupTitle": "Teamspace" + }, + { + "type": "get", + "url": "/:teamspace/settings/mitigations.csv", + "title": "Download mitigations file", + "name": "getMitigationsFile", + "group": "Teamspace", + "description": "

Returns a CSV file containing all defined suggested risk mitigations.

", + "examples": [ + { + "title": "Example usage", + "content": "GET /acme/settings/mitigations.csv HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/teamspace.js", + "groupTitle": "Teamspace", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/quota", + "title": "Get Quota Information", + "name": "getQuotaInfo", + "group": "Teamspace", + "description": "

It returns the quota information. Each teamspace has a space limit and a limit of collaborators. The values returned are space used (both these values are in bytes) and the collaborator limit. If spaceLimit or collaboratorLimit are nulled it means that there are no space limit/member limit.

", + "permission": [ + { + "name": "teamSpaceAdmin" + } + ], + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/quota HTTP/1.1", + "type": "get" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "success": { + "examples": [ + { + "title": "Success", + "content": "HTTP/1.1 200 OK\n{\n spaceLimit: 1048576,\n\t collaboratorLimit: 12,\n spaceUsed: 2048\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/teamspace.js", + "groupTitle": "Teamspace" + }, + { + "type": "get", + "url": "/:teamspace/settings", + "title": "Get teamspace settings", + "name": "getTeamspaceSettings", + "group": "Teamspace", + "description": "

Returns all teamspace settings.

", + "examples": [ + { + "title": "Example usage", + "content": "GET /acme/settings HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"riskCategories\":[\n\t\t\"Commercial Issue\",\n\t\t\"Environmental Issue\",\n\t\t\"Health - Material effect\",\n\t\t\"Health - Mechanical effect\",\n\t\t\"Safety Issue - Fall\",\n\t\t\"Safety Issue - Trapped\",\n\t\t\"Safety Issue - Event\",\n\t\t\"Safety Issue - Handling\",\n\t\t\"Safety Issue - Struck\",\n\t\t\"Safety Issue - Public\",\n\t\t\"Social Issue\",\n\t\t\"Other Issue\",\n\t\t\"UNKNOWN\"\n\t],\n\t\"topicTypes\":[\n\t\t\"For information\",\n\t\t\"VR\",\n\t\t\"Clash\",\n\t\t\"Diff\",\n\t\t\"RFI\",\n\t\t\"Risk\",\n\t\t\"H&S\",\n\t\t\"Design\",\n\t\t\"Constructibility\",\n\t\t\"GIS\"\n\t],\n\t\"mitigationsUpdatedAt\":1567156228976,\n\t\"_id\":\"acme\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/teamspace.js", + "groupTitle": "Teamspace", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + } + }, + { + "type": "delete", + "url": "/:teamspace/members/:user", + "title": "Remove from the teamspace", + "name": "removeTeamMember", + "group": "Teamspace", + "description": "

Removes a user from the teampspace.

", + "permission": [ + { + "name": "teamSpaceAdmin" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user", + "description": "

Username of the member to remove

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "DELETE /teamSpace1/members/viewerTeamspace1Model1JobB HTTP/1.1", + "type": "delete" + } + ], + "success": { + "examples": [ + { + "title": "Success", + "content": "HTTP/1.1 200 OK\n{\n user: \"viewerTeamspace1Model1JobB\",\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/teamspace.js", + "groupTitle": "Teamspace" + }, + { + "type": "patch", + "url": "/:teamspace/settings", + "title": "Update teamspace settings", + "name": "updateTeamspaceSettings", + "group": "Teamspace", + "description": "

Update teamspace settings.

", + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "String[]", + "optional": true, + "field": "riskCategories", + "description": "

List of risk categories

" + }, + { + "group": "Request body", + "type": "String[]", + "optional": true, + "field": "topicTypes", + "description": "

List of issue topic types

" + } + ], + "Risk category": [ + { + "group": "Risk category", + "type": "String", + "optional": false, + "field": "value", + "description": "

Value of risk category

" + }, + { + "group": "Risk category", + "type": "String", + "optional": false, + "field": "label", + "description": "

Label for risk category

" + } + ], + "Topic type": [ + { + "group": "Topic type", + "type": "String", + "optional": false, + "field": "value", + "description": "

Value of topic type

" + }, + { + "group": "Topic type", + "type": "String", + "optional": false, + "field": "label", + "description": "

Label for topic type

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage", + "content": "PUT /acme/settings HTTP/1.1\n{\n\t\"topicTypes\":[\n\t\t\"New Topic 1\",\n\t\t\"New Topic 2\"\n\t],\n\t\"riskCategories\":[\n\t\t\"New Category 1\",\n\t\t\"NEW CATEGORY 2\"\n\t]\n}", + "type": "put" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"riskCategories\":[\n\t\t\"New Category 1\",\n\t\t\"NEW CATEGORY 2\"\n\t],\n\t\"topicTypes\":[\n\t\t\"New Topic 1\",\n\t\t\"New Topic 2\"\n\t],\n\t\"mitigationsUpdatedAt\":1567156228976,\n\t\"_id\":\"acme\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/teamspace.js", + "groupTitle": "Teamspace" + }, + { + "type": "post", + "url": "/:teamspace/settings/mitigations.csv", + "title": "Upload mitigations file", + "name": "uploadMitigationsFile", + "group": "Teamspace", + "description": "

Upload a risk mitigations CSV file to a teamspace.

", + "examples": [ + { + "title": "Example usage", + "content": "POST /acme/settings/mitigations.csv HTTP/1.1\n", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"status\":\"ok\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/teamspace.js", + "groupTitle": "Teamspace", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + } + }, + { + "type": "get", + "url": "/starredMeta", + "title": "Gets the starred metadata tags for the logged user", + "description": "

This endpoint returns the starred metadata tags. You can manage the starred metadata in the frontend from BIM (i) icon in the viewer.

", + "success": { + "examples": [ + { + "title": "Success", + "content": "HTTP/1.1 200 OK\n[\n \"material\",\n \"color\",\n \"base offset\"\n]", + "type": "json" + } + ] + }, + "name": "GetStarredMetadataTags", + "group": "User", + "version": "0.0.0", + "filename": "src/v4/routes/user.js", + "groupTitle": "User" + }, + { + "type": "get", + "url": "/starredModels", + "title": "Gets the starred models for the logged user", + "name": "GetStarredModels", + "group": "User", + "version": "0.0.0", + "filename": "src/v4/routes/user.js", + "groupTitle": "User" + }, + { + "type": "put", + "url": "/starredMeta", + "title": "Replaces the whole starred metadata tags array for the logged user", + "name": "SetMetadataTags", + "group": "User", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "optional": true, + "field": "String", + "description": "

(Request body) An array of tags to be starred

" + } + ] + }, + "examples": [ + { + "title": "Input", + "content": " [\n \t\"material\",\n\t \t\"color\"\n\t ]", + "type": "json" + } + ] + }, + "success": { + "examples": [ + { + "title": "Success", + "content": " HTTP/1.1 200 OK\n\t {}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "Error 4xx": [ + { + "group": "Error 4xx", + "optional": false, + "field": "400", + "description": "

BadRequest The request was malformed

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/user.js", + "groupTitle": "User" + }, + { + "type": "put", + "url": "/starredModels", + "title": "Sets the whole starred models for the logged user", + "name": "SetStarredModels", + "group": "User", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "optional": true, + "field": "String", + "description": "

An array of models to be starred, belong to the teamspace

" + } + ] + }, + "examples": [ + { + "title": "Input", + "content": " {\n \t\"user1\": [\"c7d9184a-83d3-4ef0-975c-ba2ced888e79\"],\n \t\"user2\": [\"4d17e126-8238-432d-a421-93819373e21a\", \"0411e74a-0661-48f9-bf4f-8eabe4a673a0\"]\n\t }", + "type": "json" + } + ] + }, + "success": { + "examples": [ + { + "title": "Success", + "content": " HTTP/1.1 200 OK\n\t {}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "Error 4xx": [ + { + "group": "Error 4xx", + "optional": false, + "field": "400", + "description": "

BadRequest The request was malformed

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/user.js", + "groupTitle": "User" + }, + { + "type": "post", + "url": "/starredMeta", + "title": "Adds a starred metadata tag for the logged user", + "name": "StarMetadataTags", + "group": "User", + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "tag", + "description": "

The tag to be starred

" + } + ] + }, + "examples": [ + { + "title": "Input", + "content": "{\n \"tag\": \"material\"\n}", + "type": "json" + } + ] + }, + "success": { + "examples": [ + { + "title": "Success", + "content": " HTTP/1.1 200 OK\n\t {}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "Error 4xx": [ + { + "group": "Error 4xx", + "optional": false, + "field": "400", + "description": "

BadRequest The request was malformed

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/user.js", + "groupTitle": "User" + }, + { + "type": "post", + "url": "/starredModels", + "title": "Adds a starred models for the logged user", + "name": "StarModels", + "group": "User", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

teamspace where model resides

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

model ID to add

" + } + ] + }, + "examples": [ + { + "title": "Input", + "content": "{\n \"teamspace\": \"user1\",\n \"model\": \"c7d9184a-83d3-4ef0-975c-ba2ced888e79\"\n}", + "type": "json" + } + ] + }, + "success": { + "examples": [ + { + "title": "Success", + "content": " HTTP/1.1 200 OK\n\t {}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "Error 4xx": [ + { + "group": "Error 4xx", + "optional": false, + "field": "400", + "description": "

BadRequest The request was malformed

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/user.js", + "groupTitle": "User" + }, + { + "type": "delete", + "url": "/starredMeta", + "title": "removes a starred metadata tag for the logged user if the tag exists", + "name": "UnstarMetadataTags", + "group": "User", + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "tag", + "description": "

The tag to be starred

" + } + ] + }, + "examples": [ + { + "title": "Input", + "content": "{\n \"tag\": \"material\"\n}", + "type": "json" + } + ] + }, + "success": { + "examples": [ + { + "title": "Success", + "content": " HTTP/1.1 200 OK\n\t {}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "Error 4xx": [ + { + "group": "Error 4xx", + "optional": false, + "field": "400", + "description": "

BadRequest The request was malformed

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/user.js", + "groupTitle": "User" + }, + { + "type": "delete", + "url": "/starredModels", + "title": "removes a starred models for the logged user if the tag exists", + "name": "UnstarModels", + "group": "User", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

teamspace where model resides

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

model ID to remove

" + } + ] + }, + "examples": [ + { + "title": "Input", + "content": "{\n \"teamspace\": \"user1\",\n \"model\": \"c7d9184a-83d3-4ef0-975c-ba2ced888e79\"\n}", + "type": "json" + } + ] + }, + "success": { + "examples": [ + { + "title": "Success", + "content": " HTTP/1.1 200 OK\n\t {}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "Error 4xx": [ + { + "group": "Error 4xx", + "optional": false, + "field": "400", + "description": "

BadRequest The request was malformed

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/user.js", + "groupTitle": "User" + }, + { + "type": "delete", + "url": "/apikey", + "title": "Deletes the current apikey for the logged user", + "name": "deleteApiKey_HTTP_1_1_200_OK___", + "group": "User", + "version": "0.0.0", + "filename": "src/v4/routes/user.js", + "groupTitle": "User" + }, + { + "type": "post", + "url": "/apikey", + "title": "Generates an apikey for the logged user", + "name": "generateApiKey", + "success": { + "examples": [ + { + "title": "Success", + "content": "HTTP/1.1 200 OK\n{\n apiKey:\"20f947a673dce5419ce187ca7998a68f\"\n}", + "type": "json" + } + ] + }, + "group": "User", + "version": "0.0.0", + "filename": "src/v4/routes/user.js", + "groupTitle": "User" + }, + { + "type": "get", + "url": "/me", + "title": "Gets the profile for the logged user", + "name": "getProfile", + "success": { + "examples": [ + { + "title": "Success", + "content": "HTTP/1.1 200 OK\n{\n username: \"jasonv\",\n firstName: \"Jason\",\n lastName: \"Voorhees\",\n email: \"jason@vorhees.com\",\n hasAvatar: true\n}", + "type": "json" + } + ] + }, + "group": "User", + "version": "0.0.0", + "filename": "src/v4/routes/user.js", + "groupTitle": "User" + }, + { + "type": "post", + "url": "/:teamspace/:model/viewpoints/", + "title": "Create view", + "name": "createView", + "group": "Views", + "description": "

Create a new view.

", + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "name", + "description": "

Name of view

" + }, + { + "group": "Request body", + "type": "Viewpoint", + "optional": false, + "field": "viewpoint", + "description": "

Viewpoint

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "screenshot", + "description": "

Screenshot

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "clippingPlanes", + "description": "

List of clipping planes

" + } + ], + "Request body: screenshot": [ + { + "group": "Request body: screenshot", + "type": "String", + "optional": false, + "field": "base64", + "description": "

Screenshot image in base64

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /acme/00000000-0000-0000-0000-000000000000/viewpoints HTTP/1.1\n{\n\t\"clippingPlanes\":[],\n\t\"name\":\"View 3\",\n\t\"screenshot\":{\n\t\t\"base64\":\n\t}\n\t\"viewpoint\":{\n\t\t\"aspect_ratio\":1.1715909242630005,\n\t\t\"far\":233419.5625,\n\t\t\"fov\":1.0471975803375244,\n\t\t\"highlighted_group_id\":\"\",\n\t\t\"look_at\":[34448.78125, 2989.078125, 17619.7265625],\n\t\t\"near\":466.839111328125,\n\t\t\"position\":[34448.78125, 163958.484375, 17620.015625],\n\t\t\"right\":[0.9999919533729553, -7.683411240577698e-9, 0.00400533527135849],\n\t\t\"up\":[0.00400533527135849, 0.0000017881393432617188, -0.9999920129776001],\n\t\t\"view_dir\":[-6.984919309616089e-10, -1, -0.0000017881393432617188]\n\t}\n}", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"_id\":\"00000000-0000-0000-0000-000000000001\"\n}", + "type": "png" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/view.js", + "groupTitle": "Views" + }, + { + "type": "delete", + "url": "/:teamspace/:model/viewpoints/:viewId", + "title": "Delete view", + "name": "deleteView", + "group": "Views", + "description": "

Delete a view.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "viewId", + "description": "

View ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "DELETE /acme/00000000-0000-0000-0000-000000000000/viewpoints/00000000-0000-0000-0000-000000000000 HTTP/1.1", + "type": "delete" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"status\":\"success\"\n}", + "type": "png" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/view.js", + "groupTitle": "Views" + }, + { + "type": "get", + "url": "/:teamspace/:model/viewpoints/:viewId", + "title": "Get view", + "name": "findView", + "group": "Views", + "description": "

Retrieve a view.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "viewId", + "description": "

View ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Type: ResultViewpoint": [ + { + "group": "Type: ResultViewpoint", + "type": "Number[3]", + "optional": false, + "field": "right", + "description": "

The right vector of the viewpoint indicating the direction of right in relative coordinates.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number[3]", + "optional": false, + "field": "up", + "description": "

The up vector of the viewpoint indicating the direction of up in relative coordinates.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number[3]", + "optional": false, + "field": "position", + "description": "

The position vector indicates where in the world the viewpoint is positioned.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number[3]", + "optional": false, + "field": "look_at", + "description": "

The vector indicating where in the world the viewpoint is looking at.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number[3]", + "optional": false, + "field": "view_dir", + "description": "

The vector indicating where is the viewpoint is looking at in relative coordinates.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number", + "optional": false, + "field": "near", + "description": "

The vector indicating the near plane.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number", + "optional": false, + "field": "far", + "description": "

The vector indicating the far plane.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number", + "optional": false, + "field": "fov", + "description": "

The angle of the field of view.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number", + "optional": false, + "field": "aspect_ratio", + "description": "

The aspect ratio of the fustrum.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "ClippingPlane[]", + "optional": true, + "field": "clippingPlanes", + "description": "

the clipping planes associated with the viewpoint

" + }, + { + "group": "Type: ResultViewpoint", + "type": "String", + "optional": true, + "field": "highlighted_group_id", + "description": "

If the viewpoint is associated with one or more highlighted objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: ResultViewpoint", + "type": "String", + "optional": true, + "field": "hidden_group_id", + "description": "

If the viewpoint is associated with one or more hidden objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: ResultViewpoint", + "type": "String", + "optional": true, + "field": "shown_group_id", + "description": "

If the viewpoint is associated with one or more shown objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: ResultViewpoint", + "type": "String[]", + "optional": true, + "field": "override_group_ids", + "description": "

If the viewpoint has one or more objects with colour override this field has an array of groups ids with one group for each colour

" + }, + { + "group": "Type: ResultViewpoint", + "type": "String[]", + "optional": true, + "field": "transformation_group_ids", + "description": "

List of group IDs with transformations

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Boolean", + "optional": false, + "field": "hide_IFC", + "description": "

A flag to hide the IFC

" + }, + { + "group": "Type: ResultViewpoint", + "type": "String", + "optional": false, + "field": "screenshot", + "description": "

A string in base64 representing the screenshot associated with the viewpoint

" + } + ], + "Type: ClippingPlane": [ + { + "group": "Type: ClippingPlane", + "type": "Number[3]", + "optional": false, + "field": "normal", + "description": "

The normal of the plane defined for the clipping plane

" + }, + { + "group": "Type: ClippingPlane", + "type": "Number", + "optional": false, + "field": "distance", + "description": "

The distance for the clipping plane to the origin

" + }, + { + "group": "Type: ClippingPlane", + "type": "Number", + "optional": false, + "field": "clipDirection", + "description": "

The direction to the clipping plane will cut the model; above or below the plane. Possible values: 1 , -1.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/viewpoints/00000000-0000-0000-0000-000000000001 HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"_id\":\"00000000-0000-0000-0000-000000000001\",\n\t\"thumbnail\":\"charence/00000000-0000-0000-0000-000000000000/viewpoints/00000000-0000-0000-0000-000000000001/thumbnail.png\",\n\t\"viewpoint\":{\n\t\t\"right\":[1.0,-0.0,0.0],\n\t\t\"up\":[0.0,0.0,-1.0],\n\t\t\"position\":[35000.0,150000.0,20000.0],\n\t\t\"look_at\":[35000.0,3000.0,20000.0],\n\t\t\"view_dir\":[-0.0,-1,-0.0],\n\t\t\"near\":100.0,\n\t\t\"far\":100000.0,\n\t\t\"fov\":1.0,\n\t\t\"aspect_ratio\":1.185,\n\t\t\"clippingPlanes\":[],\n\t\t\"highlighted_group_id\":\"\"\n\t},\n\t\"clippingPlanes\":[],\n\t\"screenshot\":{\n\t\t\"thumbnailUrl\":,\n\t\t\"thumbnail\":\"charence/00000000-0000-0000-0000-000000000000/viewpoints/00000000-0000-0000-0000-000000000001/thumbnail.png\"\n\t},\n\t\"name\":\"View1\"\n}", + "type": "png" + } + ], + "fields": { + "View object": [ + { + "group": "View object", + "type": "String", + "optional": false, + "field": "_id", + "description": "

View ID

" + }, + { + "group": "View object", + "type": "String", + "optional": false, + "field": "name", + "description": "

Name of view

" + }, + { + "group": "View object", + "type": "String", + "optional": false, + "field": "thumbnail", + "description": "

Thumbnail image

" + }, + { + "group": "View object", + "type": "ResultViewpoint", + "optional": false, + "field": "viewpoint", + "description": "

Viewpoint properties

" + }, + { + "group": "View object", + "type": "Number[]", + "optional": false, + "field": "clippingPlanes", + "description": "

[DEPRECATED] Array of clipping planes

" + }, + { + "group": "View object", + "type": "Object", + "optional": false, + "field": "screenshot", + "description": "

[DEPRECATED] Screenshot object

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/view.js", + "groupTitle": "Views" + }, + { + "type": "get", + "url": "/:teamspace/:model/viewpoints/:viewId/thumbnail.png", + "title": "Get view thumbnail", + "name": "getThumbnail", + "group": "Views", + "description": "

Retrieve a view's thumbnail image.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "viewId", + "description": "

View ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/viewpoints/00000000-0000-0000-0000-000000000000/thumbnail.png HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/view.js", + "groupTitle": "Views" + }, + { + "type": "get", + "url": "/:teamspace/:model/viewpoints", + "title": "List all views", + "name": "listViews", + "group": "Views", + "description": "

List all model views.

", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Object[]", + "optional": false, + "field": "views", + "description": "

List of view objects

" + } + ], + "View object": [ + { + "group": "View object", + "type": "String", + "optional": false, + "field": "_id", + "description": "

View ID

" + }, + { + "group": "View object", + "type": "String", + "optional": false, + "field": "name", + "description": "

Name of view

" + }, + { + "group": "View object", + "type": "String", + "optional": false, + "field": "thumbnail", + "description": "

Thumbnail image

" + }, + { + "group": "View object", + "type": "ResultViewpoint", + "optional": false, + "field": "viewpoint", + "description": "

Viewpoint properties

" + }, + { + "group": "View object", + "type": "Number[]", + "optional": false, + "field": "clippingPlanes", + "description": "

[DEPRECATED] Array of clipping planes

" + }, + { + "group": "View object", + "type": "Object", + "optional": false, + "field": "screenshot", + "description": "

[DEPRECATED] Screenshot object

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"_id\":\"00000000-0000-0000-0000-000000000001\",\n\t\t\"thumbnail\":\"charence/00000000-0000-0000-0000-000000000000/viewpoints/00000000-0000-0000-0000-000000000001/thumbnail.png\",\n\t\t\"viewpoint\":{\n\t\t\t\"right\":[1.0,-0.0,0.0],\n\t\t\t\"up\":[0.0,0.0,-1.0],\n\t\t\t\"position\":[35000.0,150000.0,20000.0],\n\t\t\t\"look_at\":[35000.0,3000.0,20000.0],\n\t\t\t\"view_dir\":[-0.0,-1,-0.0],\n\t\t\t\"near\":100.0,\n\t\t\t\"far\":100000.0,\n\t\t\t\"fov\":1.0,\n\t\t\t\"aspect_ratio\":1.185,\n\t\t\t\"clippingPlanes\":[],\n\t\t\t\"highlighted_group_id\":\"\"\n\t\t},\n\t\t\"clippingPlanes\":[],\n\t\t\"screenshot\":{\n\t\t\t\"thumbnailUrl\":,\n\t\t\t\"thumbnail\":\"charence/00000000-0000-0000-0000-000000000000/viewpoints/00000000-0000-0000-0000-000000000001/thumbnail.png\"\n\t\t},\n\t\t\"name\":\"View1\"\n\t},\n\t{\n\t\t\"_id\":\"00000000-0000-0000-0000-000000000002\",\n\t\t\"thumbnail\":\"charence/00000000-0000-0000-0000-000000000000/viewpoints/00000000-0000-0000-0000-000000000002/thumbnail.png\",\n\t\t\"viewpoint\":{\n\t\t\t\"right\":[1.0,-0.0,0.5],\n\t\t\t\"up\":[0.0,0.0,-1.0],\n\t\t\t\"position\":[20000.0,-50000.0,10000.0],\n\t\t\t\"look_at\":[20000.0,5000.0,10000.0],\n\t\t\t\"view_dir\":[0.0,-1,0.0],\n\t\t\t\"near\":100.0,\n\t\t\t\"far\":100000.0,\n\t\t\t\"fov\":1.0,\n\t\t\t\"aspect_ratio\":1.185,\n\t\t\t\"clippingPlanes\":[],\n\t\t\t\"highlighted_group_id\":\"\"\n\t\t},\n\t\t\"clippingPlanes\":[],\n\t\t\"screenshot\":{\n\t\t\t\"thumbnailUrl\":,\n\t\t\t\"thumbnail\":\"charence/00000000-0000-0000-0000-000000000000/viewpoints/00000000-0000-0000-0000-000000000002/thumbnail.png\"\n\t\t},\n\t\t\"name\":\"View2\"\n\t}\n]", + "type": "png" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/viewpoints HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/view.js", + "groupTitle": "Views", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Type: ResultViewpoint": [ + { + "group": "Type: ResultViewpoint", + "type": "Number[3]", + "optional": false, + "field": "right", + "description": "

The right vector of the viewpoint indicating the direction of right in relative coordinates.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number[3]", + "optional": false, + "field": "up", + "description": "

The up vector of the viewpoint indicating the direction of up in relative coordinates.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number[3]", + "optional": false, + "field": "position", + "description": "

The position vector indicates where in the world the viewpoint is positioned.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number[3]", + "optional": false, + "field": "look_at", + "description": "

The vector indicating where in the world the viewpoint is looking at.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number[3]", + "optional": false, + "field": "view_dir", + "description": "

The vector indicating where is the viewpoint is looking at in relative coordinates.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number", + "optional": false, + "field": "near", + "description": "

The vector indicating the near plane.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number", + "optional": false, + "field": "far", + "description": "

The vector indicating the far plane.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number", + "optional": false, + "field": "fov", + "description": "

The angle of the field of view.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number", + "optional": false, + "field": "aspect_ratio", + "description": "

The aspect ratio of the fustrum.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "ClippingPlane[]", + "optional": true, + "field": "clippingPlanes", + "description": "

the clipping planes associated with the viewpoint

" + }, + { + "group": "Type: ResultViewpoint", + "type": "String", + "optional": true, + "field": "highlighted_group_id", + "description": "

If the viewpoint is associated with one or more highlighted objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: ResultViewpoint", + "type": "String", + "optional": true, + "field": "hidden_group_id", + "description": "

If the viewpoint is associated with one or more hidden objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: ResultViewpoint", + "type": "String", + "optional": true, + "field": "shown_group_id", + "description": "

If the viewpoint is associated with one or more shown objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: ResultViewpoint", + "type": "String[]", + "optional": true, + "field": "override_group_ids", + "description": "

If the viewpoint has one or more objects with colour override this field has an array of groups ids with one group for each colour

" + }, + { + "group": "Type: ResultViewpoint", + "type": "String[]", + "optional": true, + "field": "transformation_group_ids", + "description": "

List of group IDs with transformations

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Boolean", + "optional": false, + "field": "hide_IFC", + "description": "

A flag to hide the IFC

" + }, + { + "group": "Type: ResultViewpoint", + "type": "String", + "optional": false, + "field": "screenshot", + "description": "

A string in base64 representing the screenshot associated with the viewpoint

" + } + ], + "Type: ClippingPlane": [ + { + "group": "Type: ClippingPlane", + "type": "Number[3]", + "optional": false, + "field": "normal", + "description": "

The normal of the plane defined for the clipping plane

" + }, + { + "group": "Type: ClippingPlane", + "type": "Number", + "optional": false, + "field": "distance", + "description": "

The distance for the clipping plane to the origin

" + }, + { + "group": "Type: ClippingPlane", + "type": "Number", + "optional": false, + "field": "clipDirection", + "description": "

The direction to the clipping plane will cut the model; above or below the plane. Possible values: 1 , -1.

" + } + ] + } + } + }, + { + "type": "put", + "url": "/:teamspace/:model/viewpoints/:viewId", + "title": "Update view", + "name": "updateView", + "group": "Views", + "description": "

Update a view.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "viewId", + "description": "

View ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "name", + "description": "

Name of view

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "PUT /acme/00000000-0000-0000-0000-000000000000/viewpoints/00000000-0000-0000-0000-000000000001 HTTP/1.1\n{\n\t\"name\":\"NewName\"\n}", + "type": "put" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"_id\":\"00000000-0000-0000-0000-000000000001\"\n}", + "type": "png" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/view.js", + "groupTitle": "Views" + } +] }); diff --git a/backend/docs/api_data.json b/backend/docs/api_data.json new file mode 100644 index 00000000000..7667495e545 --- /dev/null +++ b/backend/docs/api_data.json @@ -0,0 +1,14845 @@ +[ + { + "type": "get", + "url": "/version", + "title": "Application version", + "name": "printVersion", + "group": "3D_Repo", + "description": "

Show current application version.

", + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "String", + "optional": false, + "field": "VERSION", + "description": "

API service version

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "unity", + "description": "

Unity viewer version

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "navis", + "description": "

Autodesk Navisworks version

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "unitydll", + "description": "

Unity viewer version

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"VERSION\": \"2.20.1\",\n\t\"unity\": {\n\t\t\"current\": \"2.20.0\",\n\t\t\"supported\": []\n\t},\n\t\"navis\": {\n\t\t\"current\": \"2.16.0\",\n\t\t\"supported\": [\n\t\t\t\"2.8.0\"\n\t\t]\n\t},\n\t\"unitydll\": {\n\t\t\"current\": \"2.8.0\",\n\t\t\"supported\": []\n\t}\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/auth.js", + "groupTitle": "3D_Repo" + }, + { + "type": "post", + "url": "/:teamspace/permissions", + "title": "Assign permissions", + "name": "createPermission", + "group": "Account_Permission", + "description": "

Assign account level permission to a user

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "user", + "description": "

User to assign permissions to

" + }, + { + "group": "Request body", + "type": "String[]", + "optional": false, + "field": "permissions", + "description": "

List of account level permissions

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "String", + "optional": false, + "field": "user", + "description": "

User

" + }, + { + "group": "200", + "type": "String[]", + "optional": false, + "field": "permissions", + "description": "

Account Level Permission types

" + } + ] + }, + "examples": [ + { + "title": "Success-Response:", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"user\": \"bob\",\n\t\t\"permissions\": [\n\t\t\t\"create_project\"\n\t\t]\n\t}\n]", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /acme/permissions HTTP/1.1\n{\n\t\"user\": \"bob\",\n\t\"permissions\": [\n\t\t\"create_project\"\n\t]\n}", + "type": "post" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/accountPermission.js", + "groupTitle": "Account_Permission" + }, + { + "type": "delete", + "url": "/:teamspace/permissions/:user", + "title": "Revoke permissions", + "name": "deletePermission", + "group": "Account_Permission", + "description": "

Revoke all permissions from a user.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user", + "description": "

User to delete

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "DELETE /acme/permissions/alice HTTP/1.1", + "type": "delete" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/accountPermission.js", + "groupTitle": "Account_Permission" + }, + { + "type": "get", + "url": "/:teamspace/permissions", + "title": "List all permissions", + "name": "listPermissions", + "group": "Account_Permission", + "description": "

Get a list of all account permission objects for a teamspace

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "String", + "optional": false, + "field": "user", + "description": "

User

" + }, + { + "group": "200", + "type": "String[]", + "optional": false, + "field": "permissions", + "description": "

Account level permissions

" + } + ] + }, + "examples": [ + { + "title": "Success-Response:", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"user\": \"alice\",\n\t\t\"permissions\": [\n\t\t\t\"teamspace_admin\"\n\t\t]\n\t},\n\t{\n\t\t\"user\": \"bob\",\n\t\t\"permissions\": [\n\t\t\t\"create_project\"\n\t\t]\n\t}\n]", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/permissions HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/accountPermission.js", + "groupTitle": "Account_Permission" + }, + { + "type": "put", + "url": "/:teamspace/permissions/:user", + "title": "Update permissions", + "name": "updatePermission", + "group": "Account_Permission", + "description": "

Update permissions assignment for a user.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user", + "description": "

User to update

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String[]", + "optional": false, + "field": "permissions", + "description": "

List of account level permissions

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "String[]", + "optional": false, + "field": "permissions", + "description": "

List of account level permissions

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"permissions\": [\n\t\t\"teamspace_admin\"\n\t]\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "PUT /acme/permissions/alice HTTP/1.1\n{\n\t\"permissions\": [\n\t\t\"teamspace_admin\"\n\t]\n}", + "type": "put" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/accountPermission.js", + "groupTitle": "Account_Permission" + }, + { + "type": "post", + "url": "/forgot-password", + "title": "Forgot password", + "name": "forgotPassword", + "group": "Account", + "description": "

Send a password reset link to account's e-mail.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "username", + "description": "

Account username

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "email", + "description": "

E-mail address registered with account

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage (with username):", + "content": "POST /forgot-password HTTP/1.1\n{\n\t\"username: \"alice\"\n}", + "type": "get" + }, + { + "title": "Example usage (with e-mail):", + "content": "POST /forgot-password HTTP/1.1\n{\n\t\"email: \"alice@acme.co.uk\"\n}", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/auth.js", + "groupTitle": "Account" + }, + { + "type": "get", + "url": "/:user/avatar", + "title": "Get avatar", + "name": "getAvatar", + "group": "Account", + "description": "

Get user avatar.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user", + "description": "

User

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "Object", + "optional": false, + "field": "avatar", + "description": "

User Avatar Image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "json" + } + ] + }, + "error": { + "fields": { + "404": [ + { + "group": "404", + "optional": false, + "field": "USER_DOES_NOT_HAVE_AVATAR", + "description": "

User does not have an avatar

" + } + ] + }, + "examples": [ + { + "title": "Error-Response", + "content": "HTTP/1.1 404 Not Found\n{\n\t\"message\": \"User does not have an avatar\",\n\t\"status\": 404,\n\t\"code\": \"USER_DOES_NOT_HAVE_AVATAR\",\n\t\"place\": \"GET /alice/avatar\"\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /alice/avatar HTTP/1.1", + "type": "put" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/auth.js", + "groupTitle": "Account" + }, + { + "type": "get", + "url": "/:user.json", + "title": "List account information", + "name": "listInfo", + "group": "Account", + "description": "

Account information and list of projects grouped by teamspace that the user has access to.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user", + "description": "

User

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "Object[]", + "optional": false, + "field": "accounts", + "description": "

User account

" + }, + { + "group": "200", + "type": "Object", + "optional": false, + "field": "billingInfo", + "description": "

Billing information

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "email", + "description": "

User e-mail address

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "firstName", + "description": "

First name

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "lastName", + "description": "

Surname

" + }, + { + "group": "200", + "type": "Boolean", + "optional": false, + "field": "hasAvatar", + "description": "

True if user account has an avatar

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"accounts\": [\n\t\t{\n\t\t\t\"account\": \"repoman\",\n\t\t\t\"models\": [\n\t\t\t\t{\n\t\t\t\t\t\"permissions\": [\n\t\t\t\t\t\t\"change_model_settings\",\n\t\t\t\t\t\t\"upload_files\",\n\t\t\t\t\t\t\"create_issue\",\n\t\t\t\t\t\t\"comment_issue\",\n\t\t\t\t\t\t\"view_issue\",\n\t\t\t\t\t\t\"view_model\",\n\t\t\t\t\t\t\"download_model\",\n\t\t\t\t\t\t\"edit_federation\",\n\t\t\t\t\t\t\"delete_federation\",\n\t\t\t\t\t\t\"delete_model\",\n\t\t\t\t\t\t\"manage_model_permission\"\n\t\t\t\t\t],\n\t\t\t\t\t\"model\": \"00000000-0000-0000-0000-000000000000\",\n\t\t\t\t\t\"name\": \"ufo\",\n\t\t\t\t\t\"status\": \"ok\",\n\t\t\t\t\t\"timestamp\": \"2016-07-26T15:52:11.000Z\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"fedModels\": [],\n\t\t\t\"isAdmin\": true,\n\t\t\t\"permissions\": [\n\t\t\t\t\"teamspace_admin\"\n\t\t\t],\n\t\t\t\"quota\": {\n\t\t\t\t\"spaceLimit\": 10485760,\n\t\t\t\t\"collaboratorLimit\": 5,\n\t\t\t\t\"spaceUsed\": 12478764\n\t\t\t},\n\t\t\t\"projects\": []\n\t\t},\n\t\t{\n\t\t\t\"account\": \"breakingbad\",\n\t\t\t\"models\": [\n\t\t\t\t{\n\t\t\t\t\t\"permissions\": [\n\t\t\t\t\t\t\"view_issue\",\n\t\t\t\t\t\t\"view_model\",\n\t\t\t\t\t\t\"upload_files\",\n\t\t\t\t\t\t\"create_issue\"\n\t\t\t\t\t],\n\t\t\t\t\t\"model\": \"00000000-0000-0000-0000-000000000001\",\n\t\t\t\t\t\"name\": \"homelab\",\n\t\t\t\t\t\"status\": \"ok\",\n\t\t\t\t\t\"timestamp\": null\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"fedModels\": [\n\t\t\t\t{\n\t\t\t\t\t\"federate\": true,\n\t\t\t\t\t\"permissions\": [\n\t\t\t\t\t\t\"change_model_settings\",\n\t\t\t\t\t\t\"upload_files\",\n\t\t\t\t\t\t\"create_issue\",\n\t\t\t\t\t\t\"comment_issue\",\n\t\t\t\t\t\t\"view_issue\",\n\t\t\t\t\t\t\"view_model\",\n\t\t\t\t\t\t\"download_model\",\n\t\t\t\t\t\t\"edit_federation\",\n\t\t\t\t\t\t\"delete_federation\",\n\t\t\t\t\t\t\"delete_model\",\n\t\t\t\t\t\t\"manage_model_permission\"\n\t\t\t\t\t],\n\t\t\t\t\t\"model\": \"00000000-0000-0000-0000-000000000003\",\n\t\t\t\t\t\"name\": \"fed1\",\n\t\t\t\t\t\"status\": \"ok\",\n\t\t\t\t\t\"timestamp\": \"2017-05-11T12:49:59.000Z\",\n\t\t\t\t\t\"subModels\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"database\": \"breakingbad\",\n\t\t\t\t\t\t\t\"model\": \"00000000-0000-0000-0000-000000000001\",\n\t\t\t\t\t\t\t\"name\": \"homelab\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"database\": \"breakingbad\",\n\t\t\t\t\t\t\t\"model\": \"00000000-0000-0000-0000-000000000002\",\n\t\t\t\t\t\t\t\"name\": \"laundrylab\"\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"projects\": [\n\t\t\t\t{\n\t\t\t\t\t\"_id\": \"58f78c8ededbb13a982114ee\",\n\t\t\t\t\t\"name\": \"folder1\",\n\t\t\t\t\t\"permission\": [],\n\t\t\t\t\t\"models\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"permissions\": [\n\t\t\t\t\t\t\t\t\"view_issue\",\n\t\t\t\t\t\t\t\t\"view_model\",\n\t\t\t\t\t\t\t\t\"upload_files\",\n\t\t\t\t\t\t\t\t\"create_issue\"\n\t\t\t\t\t\t\t],\n\t\t\t\t\t\t\t\"model\": \"00000000-0000-0000-0000-000000000004\",\n\t\t\t\t\t\t\t\"name\": \"laundrylab\",\n\t\t\t\t\t\t\t\"status\": \"ok\",\n\t\t\t\t\t\t\t\"timestamp\": null\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t],\n\t\"billingInfo\": {\n\t\t\"countryCode\": \"US\",\n\t\t\"postalCode\": \"0\",\n\t\t\"line2\": \"123\",\n\t\t\"city\": \"123\",\n\t\t\"line1\": \"123\",\n\t\t\"vat\": \"000\",\n\t\t\"company\": \"Universal Pictures\",\n\t\t\"_id\": \"59145aedf4f613668fba0f98\"\n\t},\n\t\"email\":\"alice@acme.co.uk\",\n\t\"firstName\":\"Alice\",\n\t\"lastName\":\"Allen\",\n\t\"hasAvatar\": true,\n\t\"jobs\": [\n\t\t{\n\t\t\t\"_id\": \"Director\"\n\t\t},\n\t\t{\n\t\t\t\"_id\": \"Actor\"\n\t\t},\n\t\t{\n\t\t\t\"_id\": \"Producer\n\t\t}\n\t]\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /alice.json HTTP/1.1", + "type": "delete" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/auth.js", + "groupTitle": "Account" + }, + { + "type": "put", + "url": "/:user/password", + "title": "Reset password", + "name": "resetPassword", + "group": "Account", + "description": "

Reset user account password. New password must be different.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user", + "description": "

User account

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "oldPassword", + "description": "

Old password

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "newPassword", + "description": "

New password

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "token", + "description": "

Password reset token

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "optional": false, + "field": "account", + "description": "

Account username

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"account\":\"alice\"\n}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "Error 4xx": [ + { + "group": "Error 4xx", + "optional": false, + "field": "TOKEN_INVALID", + "description": "

Token is invalid or has expired

" + } + ] + }, + "examples": [ + { + "title": "Error-Response", + "content": "HTTP/1.1 400 Bad Request\n{\n\t\"message\":\"Token is invalid or expired\",\n\t\"status\":400,\n\t\"code\":\"TOKEN_INVALID\",\n\t\"value\":59,\n\t\"place\": \"PUT /alice/password\"\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage (with old password):", + "content": "PUT /alice/password HTTP/1.1\n{\n\t\"oldPassword\":\"AW96B6\",\n\t\"newPassword\":\"TrustNo1\"\n}", + "type": "post" + }, + { + "title": "Example usage (with token):", + "content": "PUT /alice/password HTTP/1.1\n{\n\t\"token\":\"1234567890\",\n\t\"newPassword\":\"TrustNo1\"\n}", + "type": "post" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/auth.js", + "groupTitle": "Account" + }, + { + "type": "post", + "url": "/:user", + "title": "Sign up", + "name": "signUp", + "group": "Account", + "description": "

Sign up for a new user account.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user", + "description": "

New account username to register

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "password", + "description": "

Password

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "email", + "description": "

Valid e-mail address

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "firstName", + "description": "

First name

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "lastName", + "description": "

Surname

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "company", + "description": "

Company

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "jobTitle", + "description": "

Job title

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "countryCode", + "description": "

ISO 3166-1 alpha-2

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "captcha", + "description": "

Google reCAPTCHA response token

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "optional": false, + "field": "account", + "description": "

New Account username

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"account\":\"alice\"\n}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "Error 4xx": [ + { + "group": "Error 4xx", + "optional": false, + "field": "SIGN_UP_PASSWORD_MISSING", + "description": "

Password is missing

" + } + ] + }, + "examples": [ + { + "title": "Error-Response", + "content": "\nHTTP/1.1 400 Bad Request\n{\n\t\"message\": \"Password is missing\",\n\t\"status\": 400,\n\t\"code\": \"SIGN_UP_PASSWORD_MISSING\",\n\t\"value\": 57,\n\t\"place\": \"POST /nabile\"\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /alice HTTP/1.1\n{\n\t\"email\":\"alice@acme.co.uk\",\n\t\"password\":\"AW96B6\",\n\t\"firstName\":\"Alice\",\n\t\"lastName\":\"Allen\",\n\t\"company\":\"Acme Corporation\",\n\t\"countryCode\":\"GB\",\n\t\"jobTitle\":\"CEO\",\n\t\"captcha\":\"1234567890qwertyuiop\"\n}", + "type": "post" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/auth.js", + "groupTitle": "Account" + }, + { + "type": "put", + "url": "/:user", + "title": "Update user account", + "name": "updateUser", + "group": "Account", + "description": "

Update account information.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user", + "description": "

Account username

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "email", + "description": "

Valid e-mail address

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "firstName", + "description": "

First name

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "lastName", + "description": "

Surname

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "optional": false, + "field": "account", + "description": "

Account username

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"account\":\"alice\"\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "PUT /alice HTTP/1.1\n{\n\t\"email\":\"alice@3drepo.org\",\n\t\"firstName\":\"Alice\",\n\t\"lastName\":\"Anderson\"\n}", + "type": "post" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/auth.js", + "groupTitle": "Account" + }, + { + "type": "post", + "url": "/:user/avatar", + "title": "Upload avatar", + "name": "uploadAvatar", + "group": "Account", + "description": "

Upload a new avatar image. Only multipart form data content type will be accepted.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user", + "description": "

User

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "File", + "optional": false, + "field": "file", + "description": "

Image to upload

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /alice/avatar HTTP/1.1\nContent-Type: multipart/form-data; boundary=----WebKitFormBoundaryN8dwXAkcO1frCHLf\n\n------WebKitFormBoundaryN8dwXAkcO1frCHLf\nContent-Disposition: form-data; name=\"file\"; filename=\"avatar.png\"\nContent-Type: image/png\n\n\n------WebKitFormBoundaryN8dwXAkcO1frCHLf--", + "type": "put" + } + ], + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "Object", + "optional": false, + "field": "status", + "description": "

Status of Avatar upload.

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"status\":\"success\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/auth.js", + "groupTitle": "Account" + }, + { + "type": "post", + "url": "/:user/verify", + "title": "Verify", + "name": "verify", + "group": "Account", + "description": "

Verify an account after signing up.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user", + "description": "

Account username

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "token", + "description": "

Account verification token

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "optional": false, + "field": "account", + "description": "

Account username

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"account\":\"alice\"\n}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "Error 4xx": [ + { + "group": "Error 4xx", + "optional": false, + "field": "ALREADY_VERIFIED", + "description": "

User already verified

" + } + ] + }, + "examples": [ + { + "title": "Error-Response", + "content": "HTTP/1.1 400 Bad Request\n{\n\t\"message\": \"Already verified\",\n\t\"status\": 400,\n\t\"code\": \"ALREADY_VERIFIED\",\n\t\"value\": 60,\n\t\"place\": \"POST /alice/verify\"\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /alice/verify HTTP/1.1\n{\n\t\"token\":\"1234567890\"\n}", + "type": "post" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/auth.js", + "groupTitle": "Account" + }, + { + "type": "get", + "url": "/login", + "title": "Get current username", + "name": "checkLogin", + "group": "Authentication", + "description": "

Get the username of the logged in user.

", + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "String", + "optional": false, + "field": "username", + "description": "

Account username

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"username\": \"alice\"\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /login HTTP/1.1\n{}", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/auth.js", + "groupTitle": "Authentication" + }, + { + "type": "post", + "url": "/login", + "title": "Login", + "name": "login", + "group": "Authentication", + "description": "

3D Repo account login. Logging in generates a token that can be used for cookie-based authentication. To authentication subsequent API calls using cookie-based authentication, simply put the following into the HTTP header: Cookie: connect.sid=:sessionId

NOTE: If you use a modern browser’s XMLHttpRequest object to make API calls, you don’t need to take care of the authentication process after calling /login.

", + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "username", + "description": "

Account username

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "password", + "description": "

Account password

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "String", + "optional": false, + "field": "username", + "description": "

Account username

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\nset-cookie:connect.sid=12345678901234567890;\n{\n\t\"username\": \"alice\"\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /login HTTP/1.1\n{\n\t\"username\": \"alice\",\n\t\"password\": \"AW96B6\"\n}", + "type": "post" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/auth.js", + "groupTitle": "Authentication" + }, + { + "type": "post", + "url": "/logout", + "title": "Logout", + "name": "logout", + "group": "Authentication", + "description": "

Invalidate the authenticated session.

", + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "String", + "optional": false, + "field": "username", + "description": "

Account username

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"username\": \"alice\"\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /logout HTTP/1.1\n{}", + "type": "post" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/auth.js", + "groupTitle": "Authentication" + }, + { + "type": "post", + "url": "/:teamspace/:model/revision(/master/head|/:revId)/groups", + "title": "Create group", + "name": "createGroup", + "group": "Groups", + "description": "

Add a group to the model.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "revId", + "description": "

Revision ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "author", + "description": "

Username of group creator

" + }, + { + "group": "Request body", + "type": "Number[]", + "optional": false, + "field": "color", + "description": "

RGB colour values

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "description", + "description": "

Group description

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "name", + "description": "

Group name

" + }, + { + "group": "Request body", + "type": "Object[]", + "optional": false, + "field": "objects", + "description": "

List of objects in group

" + }, + { + "group": "Request body", + "type": "Object[]", + "optional": true, + "field": "rules", + "description": "

List of rules in group

" + }, + { + "group": "Request body", + "type": "Number[]", + "optional": true, + "field": "transformation", + "description": "

Flat 16 element array representation of 4x4 transformation matrix

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage (/master/head)", + "content": "POST /acme/00000000-0000-0000-0000-000000000000/revision/master/head/groups HTTP/1.1\n{\n\t\"name\":\"Group 1\",\n\t\"description\":\"This is the description text for the first group.\",\n\t\"author\":\"alice\",\n\t\"color\":[255,0,0],\n\t\"objects\":[\n\t\t{\n\t\t\t\"account\":\"acme\",\n\t\t\t\"model\":\"00000000-0000-0000-0000-000000000000\",\n\t\t\t\"shared_ids\":[\n\t\t\t\t\"24fdcf2d-b9eb-4fa2-a614-dfe2532493b3\",\n\t\t\t\t\"db18ef69-6d6e-49a0-846e-907346abb39d\",\n\t\t\t\t\"c532ff34-6669-4807-b7f3-6a0ffb17b027\",\n\t\t\t\t\"fec16ea6-bb7b-4f12-b39b-f06fe6bf041d\",\n\t\t\t\t\"3f881fa8-2b7b-443e-920f-396c1c85e903\"\n\t\t\t]\n\t\t}\n\t]\n}", + "type": "post" + }, + { + "title": "Example usage (/:revId)", + "content": "POST /acme/00000000-0000-0000-0000-000000000000/revision/00000000-0000-0000-0000-000000000001/groups HTTP/1.1\n{\n\t\"name\":\"Group 1\",\n\t\"description\":\"This is the description text for the first group.\",\n\t\"author\":\"alice\",\n\t\"color\":[255,0,0],\n\t\"objects\":[\n\t\t{\n\t\t\t\"account\":\"acme\",\n\t\t\t\"model\":\"00000000-0000-0000-0000-000000000000\",\n\t\t\t\"shared_ids\":[\n\t\t\t\t\"24fdcf2d-b9eb-4fa2-a614-dfe2532493b3\",\n\t\t\t\t\"db18ef69-6d6e-49a0-846e-907346abb39d\",\n\t\t\t\t\"c532ff34-6669-4807-b7f3-6a0ffb17b027\",\n\t\t\t\t\"fec16ea6-bb7b-4f12-b39b-f06fe6bf041d\",\n\t\t\t\t\"3f881fa8-2b7b-443e-920f-396c1c85e903\"\n\t\t\t]\n\t\t}\n\t]\n}", + "type": "post" + }, + { + "title": "Example usage (smart group)", + "content": "POST /acme/00000000-0000-0000-0000-000000000000/revision/master/head/groups HTTP/1.1\n{\n\t\"name\":\"Smart 1\",\n\t\"description\":\"This is a smart group of objects with type IfcWall or IfcDoor with area > 5.\",\n\t\"author\":\"alice\",\n\t\"color\":[255,0,0],\n\t\"objects\":[],\n\t\"rules\":[\n\t\t{\n\t\t\t\"field\": {\n\t\t\t\t\"operator\": \"IS\",\n\t\t\t\t\"values\": [\"Area\"]\n\t\t\t},\n\t\t\t\"operator\":\"GT\",\n\t\t\t\"values\":[5]\n\t\t},\n\t\t{\n\t\t\t\"field\": {\n\t\t\t\t\"operator\": \"IS\",\n\t\t\t\t\"values\": [\"IFC Type\"]\n\t\t\t},\n\t\t\t\"operator\":\"IS\",\n\t\t\t\"values\":[\n\t\t\t\t\"IfcWall\",\n\t\t\t\t\"IfcDoor\"\n\t\t\t]\n\t\t}\n\t]\n}", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response (normal group)", + "content": "HTTP/1.1 200 OK\n{\n\t\"_id\":\"00000000-0000-0000-0000-000000000002\",\n\t\"name\":\"Group 1\",\n\t\"description\":\"This is the description text for the first group.\",\n\t\"author\":\"alice\",\n\t\"createdAt\":\"2018-03-09T10:45:00.000Z\",\n\t\"color\":[255,0,0],\n\t\"objects\":[\n\t\t{\n\t\t\t\"account\":\"acme\",\n\t\t\t\"model\":\"00000000-0000-0000-0000-000000000000\",\n\t\t\t\"ifc_guids\":[],\n\t\t\t\"shared_ids\":[\n\t\t\t\t\"24fdcf2d-b9eb-4fa2-a614-dfe2532493b3\",\n\t\t\t\t\"db18ef69-6d6e-49a0-846e-907346abb39d\",\n\t\t\t\t\"c532ff34-6669-4807-b7f3-6a0ffb17b027\",\n\t\t\t\t\"fec16ea6-bb7b-4f12-b39b-f06fe6bf041d\",\n\t\t\t\t\"3f881fa8-2b7b-443e-920f-396c1c85e903\"\n\t\t\t]\n\t\t}\n\t],\n\t\"rules\":[]\n}", + "type": "json" + }, + { + "title": "Success-Response (smart group)", + "content": "HTTP/1.1 200 OK\n{\n\t\"_id\":\"00000000-0000-0000-0000-000000000004\",\n\t\"name\":\"Smart 1\",\n\t\"description\":\"This is a smart group of objects with type IfcWall or IfcDoor with area > 5.\",\n\t\"author\":\"alice\",\n\t\"createdAt\":\"2018-03-09T10:45:00.000Z\",\n\t\"color\":[255,0,0],\n\t\"objects\":[\n\t\t{\n\t\t\t\"account\":\"acme\",\n\t\t\t\"model\":\"00000000-0000-0000-0000-000000000000\",\n\t\t\t\"ifc_guids\":[],\n\t\t\t\"shared_ids\":[\n\t\t\t\t\"db18ef69-6d6e-49a0-846e-907346abb39d\",\n\t\t\t\t\"fec16ea6-bb7b-4f12-b39b-f06fe6bf041d\",\n\t\t\t\t\"3f881fa8-2b7b-443e-920f-396c1c85e903\"\n\t\t\t]\n\t\t}\n\t],\n\t\"rules\":[\n\t\t{\n\t\t\t\"field\": {\n\t\t\t\t\"operator\": \"IS\",\n\t\t\t\t\"values\": [\"Area\"]\n\t\t\t},\n\t\t\t\"operator\":\"GT\",\n\t\t\t\"values\":[5]\n\t\t},\n\t\t{\n\t\t\t\"field\": {\n\t\t\t\t\"operator\": \"IS\",\n\t\t\t\t\"values\": [\"IFC Type\"]\n\t\t\t},\n\t\t\t\"operator\":\"IS\",\n\t\t\t\"values\":[\n\t\t\t\t\"IfcWall\",\n\t\t\t\t\"IfcDoor\"\n\t\t\t]\n\t\t}\n\t]\n}", + "type": "json" + } + ], + "fields": { + "200": [ + { + "group": "200", + "type": "String", + "optional": false, + "field": "author", + "description": "

Username of group creator

" + }, + { + "group": "200", + "type": "Number[]", + "optional": false, + "field": "color", + "description": "

RGB colour values

" + }, + { + "group": "200", + "type": "Number", + "optional": false, + "field": "createdAt", + "description": "

Group creation timestamp in milliseconds

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "description", + "description": "

Group description

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "name", + "description": "

Group name

" + }, + { + "group": "200", + "type": "Object[]", + "optional": false, + "field": "objects", + "description": "

List of objects in group

" + }, + { + "group": "200", + "type": "Object[]", + "optional": false, + "field": "rules", + "description": "

List of rules in group

" + }, + { + "group": "200", + "type": "Number[]", + "optional": false, + "field": "transformation", + "description": "

Flat 16 element array representation of 4x4 transformation matrix

" + }, + { + "group": "200", + "type": "Number", + "optional": false, + "field": "updatedAt", + "description": "

Group update timestamp in milliseconds

" + }, + { + "group": "200", + "type": "Number", + "optional": false, + "field": "updatedBy", + "description": "

Username of last user to amend group

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "_id", + "description": "

Unique ID of group

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/group.js", + "groupTitle": "Groups", + "groupDescription": "

A grouping of model elements. Groups can either comprise of a set of manually defined elements or rules (smart group) that define the criteria for its elements.

" + }, + { + "type": "delete", + "url": "/:teamspace/:model/groups?ids=[GROUPS]", + "title": "Delete groups", + "name": "deleteGroups", + "group": "Groups", + "description": "

Delete groups.

", + "parameter": { + "fields": { + "Query": [ + { + "group": "Query", + "type": "String", + "optional": false, + "field": "GROUPS", + "description": "

Comma separated list of group IDs

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "String", + "optional": false, + "field": "status", + "description": "

Group deletion result (success|ERROR CODE)

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"status\":\"success\"\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage", + "content": "DELETE /acme/00000000-0000-0000-0000-000000000000/groups?ids=00000000-0000-0000-0000-000000000002,00000000-0000-0000-0000-000000000003 HTTP/1.1", + "type": "delete" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/group.js", + "groupTitle": "Groups", + "groupDescription": "

A grouping of model elements. Groups can either comprise of a set of manually defined elements or rules (smart group) that define the criteria for its elements.

" + }, + { + "type": "post", + "url": "/:teamspace/:model/groups/export", + "title": "Export Groups", + "name": "exportGroups", + "group": "Groups", + "description": "

This is a back-ported endpoint from V5. For details please see V5 documentation /docs/#/Federations/ExportFederationGroups

", + "version": "0.0.0", + "filename": "src/v4/routes/group.js", + "groupTitle": "Groups", + "groupDescription": "

A grouping of model elements. Groups can either comprise of a set of manually defined elements or rules (smart group) that define the criteria for its elements.

" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision(/master/head|/:revId)/groups/:groupId?[query]", + "title": "Find group", + "name": "findGroup", + "group": "Groups", + "description": "

Find a group.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "revId", + "description": "

Revision ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "groupId", + "description": "

Group ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "ifcguids", + "description": "

Flag that returns IFC GUIDs for group elements

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage (/master/head)", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/revision/master/head/groups/00000000-0000-0000-0000-000000000002 HTTP/1.1", + "type": "get" + }, + { + "title": "Example usage (/:revId)", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/revision/00000000-0000-0000-0000-000000000001/groups/00000000-0000-0000-0000-000000000002 HTTP/1.1", + "type": "get" + }, + { + "title": "Example usage (with IFC GUIDs)", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/revision/master/head/groups/00000000-0000-0000-0000-000000000004?ifcguids=true HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"author\":\"alice\",\n\t\"color\":[255,0,0],\n\t\"createdAt\":1520592300000,\n\t\"description\":\"This is the description text for the first group.\",\n\t\"name\":\"Group 1\",\n\t\"objects\":[\n\t\t{\n\t\t\t\"account\": \"acme\",\n\t\t\t\"model\": \"00000000-0000-0000-0000-000000000000\",\n\t\t\t\"ifc_guids\": [],\n\t\t\t\"shared_ids\": [\n\t\t\t\t\"24fdcf2d-b9eb-4fa2-a614-dfe2532493b3\",\n\t\t\t\t\"db18ef69-6d6e-49a0-846e-907346abb39d\",\n\t\t\t\t\"c532ff34-6669-4807-b7f3-6a0ffb17b027\",\n\t\t\t\t\"fec16ea6-bb7b-4f12-b39b-f06fe6bf041d\",\n\t\t\t\t\"3f881fa8-2b7b-443e-920f-396c1c85e903\"\n\t\t\t]\n\t\t}\n\t],\n\t\"updatedAt\":1552128300000,\n\t\"updatedBy\":\"alice\",\n\t\"_id\":\"00000000-0000-0000-0000-000000000002\"\n}", + "type": "json" + }, + { + "title": "Success-Response (with IFC GUIDs)", + "content": "HTTP/1.1 200 OK\n{\n\t\"author\":\"alice\",\n\t\"color\":[255,0,0],\n\t\"createdAt\":1520592300000,\n\t\"description\":\"This is a smart group of objects with type IfcWall or IfcDoor with area > 5.\",\n\t\"name\":\"Smart 1\",\n\t\"objects\":[\n\t\t{\n\t\t\t\"account\": \"acme\",\n\t\t\t\"model\": \"00000000-0000-0000-0000-000000000000\",\n\t\t\t\"ifc_guids\": [\n\t\t\t\t\"2cx1GdQ9fAgRIWgfhfBb84\",\n\t\t\t\t\"13NEEUJ8DEE8fEH0aHgm2z\",\n\t\t\t\t\"3OLNF2_DL6hfPgh8Bw7fI7\"\n\t\t\t],\n\t\t\t\"shared_ids\": [\n\t\t\t\t\"24fdcf2d-b9eb-4fa2-a614-dfe2532493b3\",\n\t\t\t\t\"db18ef69-6d6e-49a0-846e-907346abb39d\",\n\t\t\t\t\"c532ff34-6669-4807-b7f3-6a0ffb17b027\",\n\t\t\t\t\"fec16ea6-bb7b-4f12-b39b-f06fe6bf041d\",\n\t\t\t\t\"3f881fa8-2b7b-443e-920f-396c1c85e903\"\n\t\t\t]\n\t\t}\n\t],\n\t\"rules\":[\n\t\t{\n\t\t\t\"field\": {\n\t\t\t\t\"operator\": \"IS\",\n\t\t\t\t\"values\": [\"Area\"]\n\t\t\t},\n\t\t\t\"operator\":\"GT\",\n\t\t\t\"values\":[5]\n\t\t},\n\t\t{\n\t\t\t\"field\": {\n\t\t\t\t\"operator\": \"IS\",\n\t\t\t\t\"values\": [\"IFC Type\"]\n\t\t\t},\n\t\t\t\"operator\":\"IS\",\n\t\t\t\"values\":[\n\t\t\t\t\"IfcWall\",\n\t\t\t\t\"IfcDoor\"\n\t\t\t]\n\t\t}\n\t],\n\t\"updatedAt\":1552128300000,\n\t\"updatedBy\":\"alice\",\n\t\"_id\":\"00000000-0000-0000-0000-000000000004\"\n}", + "type": "json" + } + ], + "fields": { + "200": [ + { + "group": "200", + "type": "String", + "optional": false, + "field": "author", + "description": "

Username of group creator

" + }, + { + "group": "200", + "type": "Number[]", + "optional": false, + "field": "color", + "description": "

RGB colour values

" + }, + { + "group": "200", + "type": "Number", + "optional": false, + "field": "createdAt", + "description": "

Group creation timestamp in milliseconds

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "description", + "description": "

Group description

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "name", + "description": "

Group name

" + }, + { + "group": "200", + "type": "Object[]", + "optional": false, + "field": "objects", + "description": "

List of objects in group

" + }, + { + "group": "200", + "type": "Object[]", + "optional": false, + "field": "rules", + "description": "

List of rules in group

" + }, + { + "group": "200", + "type": "Number[]", + "optional": false, + "field": "transformation", + "description": "

Flat 16 element array representation of 4x4 transformation matrix

" + }, + { + "group": "200", + "type": "Number", + "optional": false, + "field": "updatedAt", + "description": "

Group update timestamp in milliseconds

" + }, + { + "group": "200", + "type": "Number", + "optional": false, + "field": "updatedBy", + "description": "

Username of last user to amend group

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "_id", + "description": "

Unique ID of group

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/group.js", + "groupTitle": "Groups", + "groupDescription": "

A grouping of model elements. Groups can either comprise of a set of manually defined elements or rules (smart group) that define the criteria for its elements.

" + }, + { + "type": "post", + "url": "/:teamspace/:model/groups/import", + "title": "Import Groups", + "name": "importGroups", + "group": "Groups", + "description": "

This is a back-ported endpoint from V5. For details please see V5 documentation /docs/#/Federations/ImportFederationGroups

", + "version": "0.0.0", + "filename": "src/v4/routes/group.js", + "groupTitle": "Groups", + "groupDescription": "

A grouping of model elements. Groups can either comprise of a set of manually defined elements or rules (smart group) that define the criteria for its elements.

" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision(/master/head/|/:revId)/groups?[query]", + "title": "List all groups", + "name": "listGroups", + "group": "Groups", + "description": "

List all groups associated with the model.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "revId", + "description": "

Revision unique ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "ifcguids", + "description": "

Flag that returns IFC GUIDs for group elements

" + }, + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "noIssues", + "description": "

Flag that hides groups for issues

" + }, + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "noRisks", + "description": "

Flag that hides groups for risks

" + }, + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "noViews", + "description": "

Flag that hides groups for risks

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "updatedSince", + "description": "

Only return issues that has been updated since this value (in epoch value)

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "Object[]", + "optional": false, + "field": "objects", + "description": "

List of group objects

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"author\":\"alice\",\n\t\t\"color\":[255,0,0],\n\t\t\"createdAt\":1520592300000,\n\t\t\"description\":\"This is the description text for the first group.\",\n\t\t\"name\":\"Group 1\",\n\t\t\"objects\":[\n\t\t\t{\n\t\t\t\t\"account\": \"acme\",\n\t\t\t\t\"model\": \"00000000-0000-0000-0000-000000000000\",\n\t\t\t\t\"ifc_guids\": [],\n\t\t\t\t\"shared_ids\": [\n\t\t\t\t\t\"24fdcf2d-b9eb-4fa2-a614-dfe2532493b3\",\n\t\t\t\t\t\"db18ef69-6d6e-49a0-846e-907346abb39d\",\n\t\t\t\t\t\"c532ff34-6669-4807-b7f3-6a0ffb17b027\",\n\t\t\t\t\t\"fec16ea6-bb7b-4f12-b39b-f06fe6bf041d\",\n\t\t\t\t\t\"3f881fa8-2b7b-443e-920f-396c1c85e903\"\n\t\t\t\t]\n\t\t\t}\n\t\t],\n\t\t\"updatedAt\":1552128300000,\n\t\t\"updatedBy\":\"alice\",\n\t\t\"_id\":\"00000000-0000-0000-0000-000000000002\"\n\t},\n\t{\n\t\t\"author\":\"alice\",\n\t\t\"color\":[0,255,0],\n\t\t\"createdAt\":1520592300000,\n\t\t\"description\":\"(No description)\",\n\t\t\"name\":\"Group 2\",\n\t\t\"objects\":[\n\t\t\t{\n\t\t\t\t\"account\": \"acme\",\n\t\t\t\t\"model\": \"00000000-0000-0000-0000-000000000000\",\n\t\t\t\t\"ifc_guids\": [],\n\t\t\t\t\"shared_ids\": [\n\t\t\t\t\t\"c532ff34-6669-4807-b7f3-6a0ffb17b027\",\n\t\t\t\t\t\"fec16ea6-bb7b-4f12-b39b-f06fe6bf041d\"\n\t\t\t\t]\n\t\t\t}\n\t\t],\n\t\t\"rules\":[],\n\t\t\"updatedAt\":1552128300000,\n\t\t\"updatedBy\":\"alice\",\n\t\t\"_id\":\"00000000-0000-0000-0000-000000000003\"\n\t}\n]", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage (/master/head)", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/revision/master/head/groups HTTP/1.1", + "type": "get" + }, + { + "title": "Example usage (/:revId)", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/revision/00000000-0000-0000-0000-000000000001/groups HTTP/1.1", + "type": "get" + }, + { + "title": "Example usage (no issue/risk groups)", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/revision/master/head/groups?noIssues=true&noRisks=true HTTP/1.1", + "type": "get" + }, + { + "title": "Example usage (with IFC GUIDs)", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/revision/master/head/groups?ifcguids=true HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/group.js", + "groupTitle": "Groups", + "groupDescription": "

A grouping of model elements. Groups can either comprise of a set of manually defined elements or rules (smart group) that define the criteria for its elements.

" + }, + { + "type": "put", + "url": "/:teamspace/:model/revision(/master/head|/:revId)/groups/:groupId/", + "title": "Update group", + "name": "updateGroup", + "group": "Groups", + "description": "

Update a group.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "revId", + "description": "

Revision ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "groupId", + "description": "

Group ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "author", + "description": "

Username of group creator

" + }, + { + "group": "Request body", + "type": "Number[]", + "optional": false, + "field": "color", + "description": "

RGB colour values

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "description", + "description": "

Group description

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "name", + "description": "

Group name

" + }, + { + "group": "Request body", + "type": "Object[]", + "optional": false, + "field": "objects", + "description": "

List of objects in group

" + }, + { + "group": "Request body", + "type": "Object[]", + "optional": true, + "field": "rules", + "description": "

List of rules in group

" + }, + { + "group": "Request body", + "type": "Number[]", + "optional": true, + "field": "transformation", + "description": "

Flat 16 element array representation of 4x4 transformation matrix

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage (/master/head)", + "content": "PUT /acme/00000000-0000-0000-0000-000000000000/revision/master/head/groups/00000000-0000-0000-0000-000000000002 HTTP/1.1", + "type": "put" + }, + { + "title": "Example usage (/:revId)", + "content": "PUT /acme/00000000-0000-0000-0000-000000000000/revision/00000000-0000-0000-0000-000000000001/groups/00000000-0000-0000-0000-000000000002 HTTP/1.1", + "type": "put" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"author\":\"alice\",\n\t\"color\":[255,0,0],\n\t\"createdAt\":1520592300000,\n\t\"description\":\"Updated description text.\",\n\t\"name\":\"Group 1\",\n\t\"objects\":[\n\t\t{\n\t\t\t\"account\": \"acme\",\n\t\t\t\"model\": \"00000000-0000-0000-0000-000000000000\",\n\t\t\t\"ifc_guids\": [],\n\t\t\t\"shared_ids\": [\n\t\t\t\t\"db18ef69-6d6e-49a0-846e-907346abb39d\",\n\t\t\t\t\"c532ff34-6669-4807-b7f3-6a0ffb17b027\",\n\t\t\t\t\"fec16ea6-bb7b-4f12-b39b-f06fe6bf041d\",\n\t\t\t\t\"3f881fa8-2b7b-443e-920f-396c1c85e903\"\n\t\t\t]\n\t\t}\n\t],\n\t\"updatedAt\":1552128300000,\n\t\"updatedBy\":\"alice\",\n\t\"_id\":\"00000000-0000-0000-0000-000000000002\"\n}", + "type": "json" + } + ], + "fields": { + "200": [ + { + "group": "200", + "type": "String", + "optional": false, + "field": "author", + "description": "

Username of group creator

" + }, + { + "group": "200", + "type": "Number[]", + "optional": false, + "field": "color", + "description": "

RGB colour values

" + }, + { + "group": "200", + "type": "Number", + "optional": false, + "field": "createdAt", + "description": "

Group creation timestamp in milliseconds

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "description", + "description": "

Group description

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "name", + "description": "

Group name

" + }, + { + "group": "200", + "type": "Object[]", + "optional": false, + "field": "objects", + "description": "

List of objects in group

" + }, + { + "group": "200", + "type": "Object[]", + "optional": false, + "field": "rules", + "description": "

List of rules in group

" + }, + { + "group": "200", + "type": "Number[]", + "optional": false, + "field": "transformation", + "description": "

Flat 16 element array representation of 4x4 transformation matrix

" + }, + { + "group": "200", + "type": "Number", + "optional": false, + "field": "updatedAt", + "description": "

Group update timestamp in milliseconds

" + }, + { + "group": "200", + "type": "Number", + "optional": false, + "field": "updatedBy", + "description": "

Username of last user to amend group

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "_id", + "description": "

Unique ID of group

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/group.js", + "groupTitle": "Groups", + "groupDescription": "

A grouping of model elements. Groups can either comprise of a set of manually defined elements or rules (smart group) that define the criteria for its elements.

" + }, + { + "type": "get", + "url": "/:teamspace/:model/revisions.json", + "title": "List all revisions", + "name": "listRevisions", + "group": "History", + "description": "

List all revisions for a model.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "Object", + "optional": false, + "field": "Revisions", + "description": "

object

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"_id\":\"00000000-0000-0000-0000-000000000001\",\n\t\t\"author\":\"alice\",\n\t\t\"timestamp\":\"2009-06-06T00:00:00.000Z\",\n\t\t\"name\":\"00000000-0000-0000-0000-000000000001\",\n\t\t\"branch\":\"master\"\n\t}\n]", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/revisions.json HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/history.js", + "groupTitle": "History" + }, + { + "type": "get", + "url": "/:teamspace/:model/revisions/:branch.json", + "title": "List all revisions by branch", + "name": "listRevisionsByBranch", + "group": "History", + "description": "

List all model revisions from a branch.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "branch", + "description": "

Name of revision branch

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "optional": false, + "field": "Revisions", + "description": "

object for a branch

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"_id\":\"00000000-0000-0000-0000-000000000004\",\n\t\t\"author\": \"alice\",\n\t\t\"desc\": \"For coordination\",\n\t\t\"timestamp\": \"2015-10-21T07:28:00.000Z\",\n\t\t\"name\":\"00000000-0000-0000-0000-000000000004\",\n\t\t\"branch\": \"staging\"\n\t},\n\t{\n\t\t\"_id\":\"00000000-0000-0000-0000-000000000003\",\n\t\t\"author\": \"alice\",\n\t\t\"desc\": \"Roof access added\",\n\t\t\"timestamp\": \"1985-10-26T09:00:00.000Z\",\n\t\t\"name\":\"00000000-0000-0000-0000-000000000003\",\n\t\t\"branch\": \"staging\"\n\t},\n\t{\n\t\t\"_id\":\"00000000-0000-0000-0000-000000000002\",\n\t\t\"author\": \"alice\",\n\t\t\"desc\": \"Initial design\",\n\t\t\"timestamp\": \"1955-11-12T06:38:00.000Z\",\n\t\t\"name\":\"00000000-0000-0000-0000-000000000002\",\n\t\t\"branch\": \"staging\"\n\t}\n]", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/revisions/staging.json HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/history.js", + "groupTitle": "History" + }, + { + "type": "patch", + "url": "/:teamspace/:model/revisions/:id", + "title": "Update revision status", + "name": "updateRevisionStatus", + "group": "History", + "description": "

Update the status of revision, setting it to void/active

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "id", + "description": "

Unique Revision ID or tag

" + } + ] + }, + "examples": [ + { + "title": "Input", + "content": "{\n \"void\": true\n}", + "type": "json" + } + ] + }, + "success": { + "examples": [ + { + "title": "Success", + "content": "HTTP/1.1 200 OK\n{}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/history.js", + "groupTitle": "History" + }, + { + "type": "post", + "url": "/:teamspace/invitations", + "title": "Create/Update invitation", + "name": "createInvitation", + "group": "Invitations", + "description": "

It creates or updates an invitation with the permissions and a job assigned to the invited email

", + "permission": [ + { + "name": "teamSpaceAdmin" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "email", + "description": "

The email to which the invitation will be sent

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "job", + "description": "

An existing job for the teamspace

" + }, + { + "group": "Request body", + "type": "Permissions", + "optional": false, + "field": "permissions", + "description": "

Valid permissions for the invited. If there is a teamspace_admin: true the rest of the permissions for that teamspace are ignored.

" + } + ], + "Request body: Permisssions": [ + { + "group": "Request body: Permisssions", + "type": "Boolean", + "optional": true, + "field": "teamspace_admin", + "description": "

Flag indicating if the invited user will become a teamspace administrator. If this flag is true the rest of the permissions are ignored.

" + }, + { + "group": "Request body: Permisssions", + "type": "ProjectPermissions[]", + "optional": true, + "field": "projects", + "description": "

Permissions for projects and their models.

" + } + ], + "Request body: ProjectPermissions": [ + { + "group": "Request body: ProjectPermissions", + "type": "String", + "optional": false, + "field": "project", + "description": "

The id of the project in which the project permissions will be applied for the invited user.

" + }, + { + "group": "Request body: ProjectPermissions", + "type": "Boolean", + "optional": true, + "field": "project_admin", + "description": "

Flag indicating if the invited user will become a teamspace administrator. If this flag is true the rest of the permissions are ignored.

" + }, + { + "group": "Request body: ProjectPermissions", + "type": "ModelPermissions[]", + "optional": true, + "field": "models", + "description": "

An array indicating the permissions for the models.

" + } + ], + "Request body: ModelPermissions": [ + { + "group": "Request body: ModelPermissions", + "type": "String", + "optional": false, + "field": "model", + "description": "

The id of the model that will have the permission applied for the invited user.

" + }, + { + "group": "Request body: ModelPermissions", + "type": "String", + "optional": false, + "field": "permission", + "description": "

The type of permission applied for the invited user. Valid values are 'viewer', 'commenter' or 'collaborator'

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage (with projects and models, permissions):", + "content": "POST /teamSpace1/invitations HTTP/1.1\n\t{\n\t\temail:'invited@enterprise.com'\n\t\tjob: 'jobA',\n\t\tpermissions:{\n\t\t\tprojects:[\n\t\t\t\t{\n\t\t\t\t\tproject: '5bf7df65-f3a8-4337-8016-a63f00000000',\n\t\t\t\t\tmodels: [\n\t\t\t\t\t\t{ model: '5bfc11fa-50ac-b7e7-4328-83aa11fa50ac', permission:'viewer'},\n\t\t\t\t\t\t{ model: '00b1fb4d-091d-4f11-8dd6-9deaf71f5ca5', permission:'commenter'},\n\t\t\t\t\t]\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tproject: 'Bim Logo',\n\t\t\t\t\tproject_admin: true\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}", + "type": "post" + }, + { + "title": "Example usage (with teamspace admin):", + "content": "POST /teamSpace1/invitations HTTP/1.1\n\t{\n\t\temail:'anotherinvited@enterprise.com'\n\t\tjob: 'jobA',\n\t\tpermissions: {\n\t\t\tteamspace_admin: true\n\t\t}\n\t}", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success (with projects and models, permissions)", + "content": "HTTP/1.1 200 OK\n\t{\n\t\temail:'invited@enterprise.com'\n\t\tjob: 'jobA',\n\t\tpermissions:{\n\t\t\tprojects:[\n\t\t\t\t{\n\t\t\t\t\tproject: '5bf7df65-f3a8-4337-8016-a63f00000000',\n\t\t\t\t\tmodels: [\n\t\t\t\t\t\t{ model: '5bfc11fa-50ac-b7e7-4328-83aa11fa50ac', permission:'viewer'},\n\t\t\t\t\t\t{ model: '00b1fb4d-091d-4f11-8dd6-9deaf71f5ca5', permission:'commenter'},\n\t\t\t\t\t]\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tproject: 'Bim Logo',\n\t\t\t\t\tproject_admin: true\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t}", + "type": "json" + }, + { + "title": "Success (with teamspace admin)", + "content": "HTTP/1.1 200 OK\n\t{\n\t\temail:'anotherinvited@enterprise.com'\n\t\tjob: 'jobA',\n\t\tpermissions: {\n\t\t\tteamspace_admin: true\n\t\t}\n\t}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/invitations.js", + "groupTitle": "Invitations" + }, + { + "type": "get", + "url": "/:teamspace/invitations", + "title": "Get invitations list", + "name": "getInvitations", + "group": "Invitations", + "description": "

It returns a list of invitations with their permissions and their jobs.

", + "permission": [ + { + "name": "teamSpaceAdmin" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/invitations HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success", + "content": "HTTP/1.1 200 OK\n[\n {\n \"email\": \"7e634bae01db4f@mail.com\",\n \"job\": \"jobA\",\n \"permissions\": {\n \"teamspace_admin\": true\n }\n },\n {\n \"email\": \"93393d28f953@mail.com\",\n \"job\": \"jobA\",\n \"permissions\": {\n \"projects\": [\n {\n \"project\": '5bf7df65-f3a8-4337-8016-a63f00000000',\n \"project_admin\": true\n }\n ]\n }\n },\n {\n \"email\": \"48bc8da2f3bc@mail.com\",\n \"job\": \"jobA\",\n \"permissions\": {\n \"projects\": [\n {\n \"project\": '5bf7df65-f3a8-4337-8016-a63f00000000',\n \"models\": [\n {\n \"model\": \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\",\n \"permission\": \"collaborator\"\n }\n ]\n }\n ]\n }\n }\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/invitations.js", + "groupTitle": "Invitations" + }, + { + "type": "delete", + "url": "/:teamspace/invitations/:email", + "title": "Revokes an invitation", + "name": "removeInvitation", + "group": "Invitations", + "description": "

It revokes an invitation for a teamspace

", + "permission": [ + { + "name": "teamSpaceAdmin" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "email", + "description": "

Email of the user invitation that you wish to revoke

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "DELETE /teamSpace1/invitations/invited@enterprise.com HTTP/1.1", + "type": "delete" + } + ], + "success": { + "examples": [ + { + "title": "Success", + "content": "HTTP/1.1 200 OK\n{}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/invitations.js", + "groupTitle": "Invitations" + }, + { + "type": "get", + "url": "/:teamspace/invoices", + "title": "List all invoices", + "name": "listInvoices", + "group": "Invoice", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "description": "

List all invoices if available, to current logged in user.

", + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "Object", + "optional": false, + "field": "Invoice", + "description": "

Object

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\"_id\":\"invoice_ID\",\n\t\"invoiceNo\":\"AA-111\",\n\t\"nextPaymentAmount\":00,\n\t\"taxAmount\":0,\n\t\"amount\":00,\n\t\"currency\":\"GBP\",\n\t\"transactionId\":\"transaction_ID\",\n\t\"gateway\":\"GATEWAY_PROVIDER\",\n\t\"billingAgreementId\":\"billing_agreement_ID\",\n\t\"periodEnd\":\"2018-06-03\",\n\t\"periodStart\":\"2018-05-04\",\n\t \"info\":\n\t\t{\n\t\t \"vat\":\"\",\n\t\t \"countryCode\":\"AO\",\n\t\t \"postalCode\":\"SW11 1BQ\",\n\t\t \"city\":\"London\",\n\t\t \"line2\":\"1 Street Road\",\n\t\t \"line1\":\"London\",\n\t\t \"company\":\"Comapny\",\n\t\t \"lastName\":\"User Lastname\",\n\t\t \"firstName\":\"User Firstname\",\n\t\t \"_id\":\"invoice_ID\",\n\t\t \"countryName\":\"United Kingdom\"\n\t\t},\n\t \"nextPaymentDate\":\"2018-06-04\",\n\t \"createdAt\":\"04-05-2018 15:59\",\n\t \"__v\":0,\"state\":\"complete\",\n\t \"items\":\n\t\t[{\n\t\t\t \"name\":\"pricingPlanName\",\n\t\t\t\"currency\":\"GBP\",\n\t\t\t\"amount\":00,\n\t\t\t\"taxAmount\":0,\n\t\t\t\"_id\":\"invoice_ID\",\n\t\t\t\"description\":\"Advance License (from 2018)\",\n\t\t\t\"id\":\"invoice_ID\"},\n\t\t\t {\n\t\t\t\t\"name\":\"pricingPlanName\",\n\t\t\t\t\"currency\":\"GBP\",\n\t\t\t\t\"amount\":29,\n\t\t\t\t\"taxAmount\":0,\n\t\t\t\t\"_id\":\"invoice_ID\",\n\t\t\t\t\"description\":\"This is a dummy invoice for use with API Documentation\",\n\t\t\t\t\"id\":\"invoice_ID\"\n\t\t}],\n\t\t\t\t\"type\":\"invoice\",\n\t\t\t\t\"proRata\":false,\n\t\t\t\t\"pending\":false,\n\t\t\t\t\"unitPrice\":\"29.00\",\n\t\t\t\t\"B2B_EU\":false,\n\t\t\t\t\"taxPercentage\":0,\n\t\t\t\t\"createdAtDate\":\"2018-05-04\",\n\t\t\t\t\"netAmount\":00\n\t}\n]", + "type": "json" + } + ] + }, + "error": { + "fields": { + "401": [ + { + "group": "401", + "optional": false, + "field": "NOT_AUTHORIZED", + "description": "

Not Authorized

" + } + ] + }, + "examples": [ + { + "title": "Error-Response", + "content": "\nHTTP/1.1 401 Not Authorized\n{\n\t\"message\":\"Not Authorized\",\n\t\"status\":401,\"code\":\n\t\"NOT_AUTHORIZED\",\n\t\"value\":9,\n\t\"place\":\"GET /nabile/subscriptions\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/invoice.js", + "groupTitle": "Invoice" + }, + { + "type": "get", + "url": "/:teamspace/invoices/:invoiceNo.html", + "title": "Render invoices as HTML", + "name": "renderInvoice", + "group": "Invoice", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "invoiceNo", + "description": "

Invoice number to render.

" + } + ] + } + }, + "description": "

Render a HTML web page of the requested invoice.

", + "version": "0.0.0", + "filename": "src/v4/routes/invoice.js", + "groupTitle": "Invoice" + }, + { + "type": "get", + "url": "/:teamspace/invoices/:invoiceNo.pdf", + "title": "Render invoices as PDF", + "name": "renderInvoicePDF", + "group": "Invoice", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "optional": false, + "field": "invoiceNo.pdf", + "description": "

Invoice to render.

" + } + ] + } + }, + "description": "

Render out a PDF version of the requested invocie.

", + "version": "0.0.0", + "filename": "src/v4/routes/invoice.js", + "groupTitle": "Invoice" + }, + { + "type": "post", + "url": "/:teamspace/:model/issues/:issueId/resources", + "title": "Attach resources to an issue", + "name": "attachResource", + "group": "Issues", + "description": "

Attaches file or url resources to an issue. If the type of the resource is file it should be send as multipart/form-data. Both types at the same time cant be sent. So in order to attach files and urls it should be done with two different requests.

This method triggers a chat event

", + "parameter": { + "fields": { + "Request body file resource (multipart/form-data)": [ + { + "group": "Request body file resource (multipart/form-data)", + "type": "File[]", + "optional": false, + "field": "files", + "description": "

The array of files to be attached

" + }, + { + "group": "Request body file resource (multipart/form-data)", + "type": "String[]", + "optional": false, + "field": "names", + "description": "

The names of the files; it should have the same length as the files field and should include the file extension

" + } + ], + "Request body url resource": [ + { + "group": "Request body url resource", + "type": "String[]", + "optional": false, + "field": "urls", + "description": "

The array of urls to be attached

" + }, + { + "group": "Request body url resource", + "type": "String[]", + "optional": false, + "field": "names", + "description": "

The names of the urls; it should have the same length as the url field

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "issueId", + "description": "

Issue ID

" + } + ] + } + }, + "success": { + "examples": [ + { + "title": "Success example result after two files has been uploaded", + "content": "\n[\n {\n \"_id\":\"7617f775-9eb7-4877-8ec3-98ea3457e519\",\n \"size\":1422,\n \"issueIds\":[\n \"3e8a11e0-9812-11e9-9c4d-ebde5888e062\"\n ],\n \"name\":\"todo.txt\",\n \"user\":\"teamSpace1\",\n \"createdAt\":1561973996461\n },\n {\n \"_id\":\"e25e42d5-c4f0-4fbc-a8f4-bc9899e6662a\",\n \"size\":2509356,\n \"issueIds\":[\n \"3e8a11e0-9812-11e9-9c4d-ebde5888e062\"\n ],\n \"name\":\"football.gif\",\n \"user\":\"teamSpace1\",\n \"createdAt\":1561973996462\n }\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues" + }, + { + "type": "post", + "url": "/:teamspace/:model/issues/:issueId/comments", + "title": "Add comment to issue", + "name": "commentIssue", + "group": "Issues", + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "comment", + "description": "

Comment text

" + }, + { + "group": "Request body", + "type": "Viewpoint", + "optional": true, + "field": "viewpoint", + "description": "

The viewpoint associated with the comment

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "issueId", + "description": "

Issue ID

" + } + ], + "Type: Viewpoint": [ + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "right", + "description": "

Right vector of viewpoint indicating the direction of right in relative coordinates

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "up", + "description": "

Up vector of viewpoint indicating the direction of up in relative coordinates

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "position", + "description": "

Position vector indicates where in the world the viewpoint is positioned

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "look_at", + "description": "

Vector indicating where in the world the viewpoint is looking at

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "view_dir", + "description": "

Vector indicating the direction the viewpoint is looking at in relative coordinates

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "near", + "description": "

Vector indicating the near plane

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "far", + "description": "

Vector indicating the far plane

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "fov", + "description": "

Angle of the field of view

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "aspect_ratio", + "description": "

Aspect ratio of the fustrum

" + }, + { + "group": "Type: Viewpoint", + "type": "ClippingPlane[]", + "optional": true, + "field": "clippingPlanes", + "description": "

Clipping planes associated with the viewpoint

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": true, + "field": "highlighted_group_id", + "description": "

If the viewpoint is associated with one or more highlighted objects from the model this field has the value of a group ID generated to hold those objects

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": true, + "field": "hidden_group_id", + "description": "

If the viewpoint is associated with one or more hidden objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": true, + "field": "shown_group_id", + "description": "

If the viewpoint is associated with one or more shown objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: Viewpoint", + "type": "Group", + "optional": true, + "field": "highlighted_group", + "description": "

If the viewpoint is associated with one or more highlighted objects from the model this field has the value of a group definition for those objects (this shouldnt be use simultaneously with highlighted_group_id)

" + }, + { + "group": "Type: Viewpoint", + "type": "Group", + "optional": true, + "field": "hidden_group", + "description": "

If the viewpoint is associated with one or more hidden objects from the model this field has the value of a group id generated to hold those objects (this shouldnt be use simultaneously with hidden_group_id)

" + }, + { + "group": "Type: Viewpoint", + "type": "Group", + "optional": true, + "field": "shown_group", + "description": "

If the viewpoint is associated with one or more shown objects from the model this field has the definition of the group to hold those objects (this shouldnt be use simultaneously with shown_group_id)

" + }, + { + "group": "Type: Viewpoint", + "type": "Group[]", + "optional": true, + "field": "override_groups", + "description": "

If the viewpoint has one or more objects with colour override this field has an array of groups with one group for each colour

" + }, + { + "group": "Type: Viewpoint", + "type": "Group[]", + "optional": true, + "field": "transformation_groups", + "description": "

List of groups with transformations

" + }, + { + "group": "Type: Viewpoint", + "type": "String[]", + "optional": true, + "field": "transformation_group_ids", + "description": "

List of group IDs with transformations

" + }, + { + "group": "Type: Viewpoint", + "type": "Boolean", + "optional": false, + "field": "hide_IFC", + "description": "

A flag to hide the IFC

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": false, + "field": "screenshot", + "description": "

Base64 string representing the screenshot associated with the viewpoint

" + } + ], + "Type: Group": [ + { + "group": "Type: Group", + "type": "Number[3]", + "optional": false, + "field": "color", + "description": "

RGB colour values

" + }, + { + "group": "Type: Group", + "type": "ModelObjects", + "optional": false, + "field": "objects", + "description": "

List of objects in group

" + } + ], + "Type: ModelObjects": [ + { + "group": "Type: ModelObjects", + "type": "String", + "optional": false, + "field": "account", + "description": "

The account that has the model which contains the objects

" + }, + { + "group": "Type: ModelObjects", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model id that contains the objects

" + }, + { + "group": "Type: ModelObjects", + "type": "String[]", + "optional": false, + "field": "shared_ids", + "description": "

The shared ids of objects to be selected

" + } + ], + "Type: ClippingPlane": [ + { + "group": "Type: ClippingPlane", + "type": "Number[3]", + "optional": false, + "field": "normal", + "description": "

The normal of the plane defined for the clipping plane

" + }, + { + "group": "Type: ClippingPlane", + "type": "Number", + "optional": false, + "field": "distance", + "description": "

The distance for the clipping plane to the origin

" + }, + { + "group": "Type: ClippingPlane", + "type": "Number", + "optional": false, + "field": "clipDirection", + "description": "

The direction to the clipping plane will cut the model; above or below the plane. Possible values: 1 , -1.

" + } + ] + }, + "examples": [ + { + "title": "PAYLOAD", + "content": "{\n \"comment\": \"This is a commment\",\n \"viewpoint\": {right: [-0.0374530553817749, -7.450580596923828e-9, -0.9992983341217041],…}\n}", + "type": "json" + } + ] + }, + "success": { + "examples": [ + { + "title": "Success", + "content": " HTTP/1.1 200 OK\n{\n guid: \"096de7ed-e3bb-4d5b-ae68-17a5cf7a5e5e\",\n comment: \"This is a commment\",\n created: 1558534690327,\n guid: \"096de7ed-e3bb-4d5b-ae68-17a5cf7a5e5e\",\n owner: \"username\",\n viewpoint: {right: [-0.0374530553817749, -7.450580596923828e-9, -0.9992983341217041],…}\n}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "Error 4xx": [ + { + "group": "Error 4xx", + "optional": false, + "field": "404", + "description": "

Issue not found

" + }, + { + "group": "Error 4xx", + "optional": false, + "field": "400", + "description": "

Comment with no text

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues" + }, + { + "type": "delete", + "url": "/:teamspace/:model/issues/:issueId/comments", + "title": "Deletes an comment from an issue", + "name": "commentIssue", + "group": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Json", + "optional": false, + "field": "PAYLOAD", + "description": "

The data with the comment guid to be deleted.

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "issueId", + "description": "

Issue ID

" + } + ] + }, + "examples": [ + { + "title": "PAYLOAD", + "content": "{\n guid: \"096de7ed-e3bb-4d5b-ae68-17a5cf7a5e5e\"\n}", + "type": "json" + } + ] + }, + "success": { + "examples": [ + { + "title": "Success", + "content": " HTTP/1.1 200 OK\n{\n guid: \"096de7ed-e3bb-4d5b-ae68-17a5cf7a5e5e\"\n}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "Error 4xx": [ + { + "group": "Error 4xx", + "optional": false, + "field": "404", + "description": "

Issue not found

" + }, + { + "group": "Error 4xx", + "optional": false, + "field": "401", + "description": "

Not authorized, when the user is not the owner

" + }, + { + "group": "Error 4xx", + "optional": false, + "field": "400", + "description": "

Issue comment sealed, when the user is trying to delete a comment that is sealed

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues" + }, + { + "type": "delete", + "url": "/:teamspace/:model/issues/:issueId/resources", + "title": "Detach a resource from an issue", + "name": "detachResource", + "group": "Issues", + "description": "

Detachs a resource from an issue. If the issue is the last entity the resources has been attached to it also deletes the resource from the system. This method triggers a chat event .

", + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "_id", + "description": "

The resource id to be detached

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "issueId", + "description": "

Issue ID

" + } + ] + } + }, + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n \"_id\":\"e25e42d5-c4f0-4fbc-a8f4-bc9899e6662a\",\n \"size\":2509356,\n \"issueIds\":[\n ],\n \"name\":\"football.gif\",\n \"user\":\"teamSpace1\",\n \"createdAt\":1561973996462\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues" + }, + { + "type": "get", + "url": "/:teamspace/:model/issues/:issueId", + "title": "Get issue", + "name": "findIssue", + "group": "Issues", + "description": "

Find an issue with the requested Issue ID.

", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "issue", + "description": "

The Issue matching the Issue ID

" + } + ] + }, + "examples": [ + { + "title": "Success-Response.", + "content": "HTTP/1.1 200 OK\n{\n\t\taccount: \"username\"\n\t\tassigned_roles: []\n\t\tcommentCount: 0\n\t\tcreated: 1542723030489\n\t\tcreator_role: \"3D Repo\"\n\t\tdesc: \"(No Description)\"\n\t\tmodel: \"model_ID\"\n\t\tmodelCode: \"\"\n\t\tname: \"Issue one\"\n\t\tnumber: 1\n\t\towner: \"username\"\n\t\tposition: []\n\t\tpriority: \"none\"\n\t\trev_id: \"revision_ID\"\n\t\tscale: 1\n\t\tstatus: \"open\"\n\t\tthumbnail: \"USERNAME/MODEL_ID/issues/ISSUE_ID/thumbnail.png\"\n\t\ttopic_type: \"for_information\"\n\t\ttypePrefix: \"Architectural\"\n\t\tviewCount: 1\n\t\tviewpoint: {near: 24.057758331298828, far: 12028.87890625, fov: 1.0471975803375244,…}\n\t\t__v: 0\n\t\t_id: \"ISSUE_ID\"\n}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "Error 4xx": [ + { + "group": "Error 4xx", + "optional": false, + "field": "ISSUE_NOT_FOUND", + "description": "

Issue not found

" + } + ] + }, + "examples": [ + { + "title": "HTTP/1.1 404 Not Found", + "content": "HTTP/1.1 404 Not Found\n{\n\t \"place\": \"GET /issues/:issueId\",\n\t \"status\": 500,\n\t \"message\": \"Issue not found\",\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "issueId", + "description": "

Issue ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/issues.bcfzip", + "title": "Download issues BCF file", + "name": "getIssuesBCF", + "group": "Issues", + "description": "

Download issues as a BCF file.

", + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:revId/issues.bcfzip", + "title": "Get Issues BCF zip file by revision ID", + "name": "getIssuesBCFTRid", + "group": "Issues", + "description": "

Get Issues BCF export based on revision ID.

", + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "revId", + "description": "

Revision ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/issues/:issueId/viewpoints/:viewpointId/screenshot.png", + "title": "Get issue viewpoint screenshot", + "name": "getScreenshot", + "group": "Issues", + "description": "

Get an issue viewpoint screenshot.

", + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "issueId", + "description": "

Issue ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "viewpointId", + "description": "

Viewpoint ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/issues/:issueId/viewpoints/:viewpointId/screenshotSmall.png", + "title": "Get smaller version of Issue screenshot", + "name": "getScreenshotSmall", + "group": "Issues", + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "Object", + "optional": false, + "field": "Issue", + "description": "

Screenshot.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "issueId", + "description": "

Issue ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "viewpointId", + "description": "

Viewpoint ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/issues/:issueId/thumbnail.png", + "title": "Get issue thumbnail", + "name": "getThumbnail", + "group": "Issues", + "description": "

Retrieve screenshot thumbnail image for requested issue.

", + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "Object", + "optional": false, + "field": "thumbnail", + "description": "

Thumbnail image

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "issueId", + "description": "

Issue ID

" + } + ] + } + } + }, + { + "type": "post", + "url": "/:teamspace/:model/issues.bcfzip", + "title": "Import BCF file", + "name": "importBCF", + "group": "Issues", + "description": "

Upload issues BCF file.

", + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/issues?[query]", + "title": "List Issues", + "name": "listIssues", + "group": "Issues", + "description": "

List all issues for model.

", + "success": { + "examples": [ + { + "title": "Success-Response.", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"_id\":\"ISSUE_ID\",\n\t\t\"creator_role\":\"Client\",\"scale\":1,\n\t\t\"due_date\":1543881600000,\n\t\t\"priority\":\"low\",\n\t\t\"desc\":\"reverse\",\n\t\t\"topic_type\":\"for_information\",\n\t\t\"status\":\"for approval\",\n\t\t\"owner\":\"username\",\n\t\t\"created\":1546217360002,\n\t\t\"name\":\"Without reverse\",\n\t\t\"number\":2,\n\t\t\"rev_id\":\"REVISION_ID\",\n\t\t\"__v\":0,\n\t\t\"assigned_roles\":[\"Architect\"],\n\t\t\"viewCount\":1,\n\t\t\"commentCount\":0,\n\t\t\"thumbnail\":\"nabile/MODEL_ID/issues/ISSUE_ID/thumbnail.png\",\n\t\t\"position\":[8341.8056640625,1279.962158203125,-3050.34521484375],\n\t\t\"typePrefix\":\"sample\",\n\t\t\"modelCode\":\"\",\n\t\t\"account\":\"username\",\n\t\t\"model\":\"MODEL_ID\",\n\t\t\"viewpoint\":\n\t\t\t{\n\t\t\t\t\"near\":54.739341735839844,\n\t\t\t\t\"far\":27369.669921875,\n\t\t\t\t\"fov\":1.0471975803375244,\n\t\t\t\t\"aspect_ratio\":1.451704502105713,\n\t\t\t\t\"hideIfc\":true,\n\t\t\t\t\"guid\":\"9279d95e-3aee-49c2-ba45-9d2302044597\",\n\t\t\t\t\"_id\":\"5c296790e5f57704580ca00a\",\n\t\t\t\t\"type\":\"perspective\",\n\t\t\t\t\"screenshot\":\"ACCOUNT/MODEL_ID/issues/ISSUE_ID/viewpoints/MODEL_ID/screenshot.png\",\n\t\t\t\t\"clippingPlanes\":[],\"right\":[0.7270411252975464,1.862645149230957e-8,0.6865938901901245],\n\t\t\t\t\"view_dir\":[0.6777805089950562,-0.15971262753009796,-0.7177084684371948],\n\t\t\t\t\"look_at\":[8400.001953125,2339.99951171875,-9599.9990234375],\n\t\t\t\t\"position\":[-3360.6259765625,5111.28125,2853.4453125],\n\t\t\t\t\"up\":[0.10965770483016968,0.9871635437011719,-0.11611767113208771],\n\t\t\t\t\"screenshotSmall\":\"nabile/MODEL_ID/issues/ISSUE_ID/viewpoints/MODEL_ID/screenshotSmall.png\"\n\t\t\t}\n\t}\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Query": [ + { + "group": "Query", + "type": "String", + "optional": true, + "field": "convertCoords", + "description": "

Convert coordinates to user space

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "updatedSince", + "description": "

Only return issues updated since this value (in epoch value)

" + }, + { + "group": "Query", + "type": "Number[]", + "optional": true, + "field": "numbers", + "description": "

Array of issue numbers to filter for

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "ids", + "description": "

Array of issue IDs to filter for

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "topicTypes", + "description": "

Array of topic types to filter

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "status", + "description": "

Array of status to filter

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "priorities", + "description": "

Array of priorities to filter

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "owners", + "description": "

Array of owners to filter

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "assignedRoles", + "description": "

Array of assigned roles to filter. For searching unassigned issues the one of the values should be 'Unassigned'.

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:revId/issues", + "title": "List Issues by revision ID", + "name": "listIssuesByRevision", + "group": "Issues", + "description": "

Get all issues related to specific revision ID.

", + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "Object", + "optional": false, + "field": "Issues", + "description": "

Object

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "\n[\n\t{\n\t\t\"_id\":\"issue_ID\",\n\t\t\"creator_role\":\"Client\",\n\t\t\"scale\":1,\n\t\t\"due_date\":1547424000000,\n\t\t\"priority\":\"low\",\n\t\t\"desc\":\"This is a description\",\n\t\t\"topic_type\":\"for_information\",\n\t\t\"status\":\"open\",\"owner\":\"username\",\n\t\t\"created\":1546626949432,\n\t\t\"name\":\"An Issue for API\",\n\t\t\"number\":3,\n\t\t\"rev_id\":\"9cf31c6e-37cc-4625-8cee-270cf731059e\",\n\t\t\"__v\":0,\n\t\t\"assigned_roles\":[\"Architect\"],\n\t\t\"viewCount\":1,\"commentCount\":0,\n\t\t\"thumbnail\":\"ACCOUNT/MODEL_ID/issues/ISSUE_ID/thumbnail.png\",\n\t\t\"position\":[],\n\t\t\"typePrefix\":\"sample\",\n\t\t\"modelCode\":\"\",\n\t\t\"account\":\"username\",\n\t\t\"model\":\"MODEL_ID\",\n\t\t\"viewpoint\":\n\t\t\t{\n\t\t\t\t\"near\":54.739341735839844,\n\t\t\t\t\"far\":27369.669921875,\n\t\t\t\t\"fov\":1.0471975803375244,\n\t\t\t\t\"aspect_ratio\":2.522167444229126,\n\t\t\t\t\"hideIfc\":true,\n\t\t\t\t\"guid\":\"5afbe23f-8307-42d0-ba77-f031922281ce\",\n\t\t\t\t\"_id\":\"5c2fa785b4af3c45f8f83c60\",\n\t\t\t\t\"type\":\"perspective\",\n\t\t\t\t\"screenshot\":\"username/MODEL_ID/issues/ISSUE_ID/viewpoints/5afbe23f-8307-42d0-ba77-f031922281ce/screenshot.png\",\n\t\t\t\t\"clippingPlanes\":[],\"right\":[0.7270411252975464,1.862645149230957e-8,0.6865938901901245],\n\t\t\t\t\t\"view_dir\":[0.6777805089950562,-0.15971262753009796,-0.7177084684371948],\n\t\t\t\t\t\"look_at\":[8400.001953125,2339.99951171875,-9599.9990234375],\n\t\t\t\t\t\"position\":[-3360.6259765625,5111.28125,2853.4453125],\n\t\t\t\t\t\"up\":[0.10965770483016968,0.9871635437011719,-0.11611767113208771],\n\t\t\t\t\t\"screenshotSmall\"username/MODEL_ID/issues/ISSUE_ID/viewpoints/5afbe23f-8307-42d0-ba77-f031922281ce/screenshot.png\"}\n\t}\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "revId", + "description": "

Revision ID

" + } + ], + "Query": [ + { + "group": "Query", + "type": "String", + "optional": true, + "field": "convertCoords", + "description": "

Convert coordinates to user space

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "updatedSince", + "description": "

Only return issues updated since this value (in epoch value)

" + }, + { + "group": "Query", + "type": "Number[]", + "optional": true, + "field": "numbers", + "description": "

Array of issue numbers to filter for

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "ids", + "description": "

Array of issue IDs to filter for

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "topicTypes", + "description": "

Array of topic types to filter

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "status", + "description": "

Array of status to filter

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "priorities", + "description": "

Array of priorities to filter

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "owners", + "description": "

Array of owners to filter

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "assignedRoles", + "description": "

Array of assigned roles to filter. For searching unassigned issues the one of the values should be 'Unassigned'.

" + } + ] + } + } + }, + { + "type": "post", + "url": "/:teamspace/:model/issues", + "title": "Create issue", + "name": "newIssue", + "group": "Issues", + "description": "

Creates a new issue.

", + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "name", + "description": "

The name of the issue

" + }, + { + "group": "Request body", + "type": "String[]", + "optional": false, + "field": "assigned_roles", + "description": "

The roles assigned to the issue. Even though its an array (this is for future support of multiple assigned jobs), currently it has one or none elements correspoing to the available jobs in the teamaspace.

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "status", + "description": "

The status of the issue. It can have a value of "open","in progress","for approval", "void" or "closed".

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "priority", + "description": "

The priority of the issue. It can have a value of "none", String"low", "medium" or "high".

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "topic_type", + "description": "

Type of the issue. It's value has to be one of the defined topic_types for the model. See here for more details.

" + }, + { + "group": "Request body", + "type": "Viewpoint", + "optional": false, + "field": "viewpoint", + "description": "

The viewpoint of the issue, defining the position of the camera and the screenshot for that position.

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "desc", + "description": "

The description of the created issue

" + }, + { + "group": "Request body", + "type": "Number[3]", + "optional": false, + "field": "position", + "description": "

The vector defining the pin of the issue. If the pin doesnt has an issue its an empty array.

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Type: Viewpoint": [ + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "right", + "description": "

Right vector of viewpoint indicating the direction of right in relative coordinates

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "up", + "description": "

Up vector of viewpoint indicating the direction of up in relative coordinates

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "position", + "description": "

Position vector indicates where in the world the viewpoint is positioned

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "look_at", + "description": "

Vector indicating where in the world the viewpoint is looking at

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "view_dir", + "description": "

Vector indicating the direction the viewpoint is looking at in relative coordinates

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "near", + "description": "

Vector indicating the near plane

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "far", + "description": "

Vector indicating the far plane

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "fov", + "description": "

Angle of the field of view

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "aspect_ratio", + "description": "

Aspect ratio of the fustrum

" + }, + { + "group": "Type: Viewpoint", + "type": "ClippingPlane[]", + "optional": true, + "field": "clippingPlanes", + "description": "

Clipping planes associated with the viewpoint

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": true, + "field": "highlighted_group_id", + "description": "

If the viewpoint is associated with one or more highlighted objects from the model this field has the value of a group ID generated to hold those objects

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": true, + "field": "hidden_group_id", + "description": "

If the viewpoint is associated with one or more hidden objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": true, + "field": "shown_group_id", + "description": "

If the viewpoint is associated with one or more shown objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: Viewpoint", + "type": "Group", + "optional": true, + "field": "highlighted_group", + "description": "

If the viewpoint is associated with one or more highlighted objects from the model this field has the value of a group definition for those objects (this shouldnt be use simultaneously with highlighted_group_id)

" + }, + { + "group": "Type: Viewpoint", + "type": "Group", + "optional": true, + "field": "hidden_group", + "description": "

If the viewpoint is associated with one or more hidden objects from the model this field has the value of a group id generated to hold those objects (this shouldnt be use simultaneously with hidden_group_id)

" + }, + { + "group": "Type: Viewpoint", + "type": "Group", + "optional": true, + "field": "shown_group", + "description": "

If the viewpoint is associated with one or more shown objects from the model this field has the definition of the group to hold those objects (this shouldnt be use simultaneously with shown_group_id)

" + }, + { + "group": "Type: Viewpoint", + "type": "Group[]", + "optional": true, + "field": "override_groups", + "description": "

If the viewpoint has one or more objects with colour override this field has an array of groups with one group for each colour

" + }, + { + "group": "Type: Viewpoint", + "type": "Group[]", + "optional": true, + "field": "transformation_groups", + "description": "

List of groups with transformations

" + }, + { + "group": "Type: Viewpoint", + "type": "String[]", + "optional": true, + "field": "transformation_group_ids", + "description": "

List of group IDs with transformations

" + }, + { + "group": "Type: Viewpoint", + "type": "Boolean", + "optional": false, + "field": "hide_IFC", + "description": "

A flag to hide the IFC

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": false, + "field": "screenshot", + "description": "

Base64 string representing the screenshot associated with the viewpoint

" + } + ], + "Type: Group": [ + { + "group": "Type: Group", + "type": "Number[3]", + "optional": false, + "field": "color", + "description": "

RGB colour values

" + }, + { + "group": "Type: Group", + "type": "ModelObjects", + "optional": false, + "field": "objects", + "description": "

List of objects in group

" + } + ], + "Type: ModelObjects": [ + { + "group": "Type: ModelObjects", + "type": "String", + "optional": false, + "field": "account", + "description": "

The account that has the model which contains the objects

" + }, + { + "group": "Type: ModelObjects", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model id that contains the objects

" + }, + { + "group": "Type: ModelObjects", + "type": "String[]", + "optional": false, + "field": "shared_ids", + "description": "

The shared ids of objects to be selected

" + } + ], + "Type: ClippingPlane": [ + { + "group": "Type: ClippingPlane", + "type": "Number[3]", + "optional": false, + "field": "normal", + "description": "

The normal of the plane defined for the clipping plane

" + }, + { + "group": "Type: ClippingPlane", + "type": "Number", + "optional": false, + "field": "distance", + "description": "

The distance for the clipping plane to the origin

" + }, + { + "group": "Type: ClippingPlane", + "type": "Number", + "optional": false, + "field": "clipDirection", + "description": "

The direction to the clipping plane will cut the model; above or below the plane. Possible values: 1 , -1.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/issues HTTP/1.1\n{\n \"name\": \"Amazing issue\",\n \"assigned_roles\": [\n \"jobA\"\n ],\n \"status\": \"open\",\n \"priority\": \"none\",\n \"topic_type\": \"for_information\",\n \"viewpoint\": {\n \"right\": [\n 0.8471935391426086,\n -2.2351741790771484e-8,\n 0.5312844514846802\n ],\n \"up\": [\n 0.14098820090293884,\n 0.9641460180282593,\n -0.22482173144817352\n ],\n \"position\": [\n -5828.818359375,\n 5268.15625,\n 7829.76171875\n ],\n \"look_at\": [\n -2445.6826171875,\n 3515.4658203125,\n 2434.966552734375\n ],\n \"view_dir\": [\n 0.5122357606887817,\n -0.2653723657131195,\n -0.8168182373046875\n ],\n \"near\": 20.835742950439453,\n \"far\": 10417.87109375,\n \"fov\": 1.0471975803375244,\n \"aspect_ratio\": 4.031496047973633,\n \"clippingPlanes\": [],\n \"override_groups\": [\n {\n \"color\": [\n \t 0,\n \t 106,\n \t 255,\n \t 52\n \t ],\n \t \"objects\": [\n {\n \"shared_ids\": [\n \"ffd49cfd-57fb-4c31-84f7-02b41352b54f\"\n ],\n \"account\": \"teamSpace1\",\n \"model\": \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\"\n }\n ]\n },\n {\n \"color\": [\n 96,\n 237,\n 61\n ],\n \t\"objects\": [\n \t {\n \"shared_ids\": [\n \"a4a14ee6-aa44-4f36-96bd-f80dbabf8ead\"\n ],\n \"account\": \"teamSpace1\",\n \"model\": \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\"\n }\n ]\n }\n ],\n \"transformation_groups\": [\n {\n \"transformation\": [1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16],\n \t \"objects\": [\n {\n \"shared_ids\": [\n \"ffd49cfd-57fb-4c31-84f7-02b41352b54f\"\n ],\n \"account\": \"teamSpace1\",\n \"model\": \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\"\n }\n ]\n },\n {\n \"color\": [\n 96,\n 237,\n 61\n ],\n \t\"objects\": [\n \t {\n \"shared_ids\": [\n \"a4a14ee6-aa44-4f36-96bd-f80dbabf8ead\"\n ],\n \"account\": \"teamSpace1\",\n \"model\": \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\"\n }\n ]\n }\n ],\n \"highlighted_group\": {\n \t\"objects\": [\n \t\t{\n \t\t\t\"shared_ids\": [\n \t\t\t\t\"60286d41-d897-4de6-a0ed-0929fa68be96\"\n \t\t\t],\n \t\t\t\"account\": \"teamSpace1\",\n \t\t\t\"model\": \"7cf61b4f-acdf-4295-b2d0-9b45f9f27418\"\n \t\t}\n \t],\n \t\"color\": [\n \t\t255,\n \t\t255,\n \t\t0\n \t]\n },\n \"hidden_group\": {\n \t\"objects\": [\n \t\t{\n \t\t\t\"shared_ids\": [\n \t\t\t\t\"57b0969f-6009-4e32-9153-2b17d3a3628b\"\n \t\t\t],\n \t\t\t\"account\": \"teamSpace1\",\n \t\t\t\"model\": \"b1fceab8-b0e9-4e45-850b-b9888efd6521\"\n \t\t}\n \t]\n }\n \"hideIfc\": true,\n \"screenshot\": \"iVBORw0KGgoAAAANSUhEUgAACAAAA...ggg==\"\n },\n \"desc\": \"This is the most awesome issue ever\",\n \"position\": [\n -3960.10205078125,\n 4487.1552734375,\n 3326.732177734375\n ]\n}", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n \"name\": \"Amazing issue\",\n \"assigned_roles\": [\n \"jobA\"\n ],\n \"status\": \"open\",\n \"priority\": \"none\",\n \"topic_type\": \"for_information\",\n \"owner\": \"teamSpace1\",\n \"desc\": \"This is the most awesome issue ever\",\n \"rev_id\": \"330f909b-9279-41aa-a87c-1c46f53a8e93\",\n \"creator_role\": \"jobA\",\n \"scale\": 1,\n \"position\": [\n -3960.10205078125,\n 4487.1552734375,\n 3326.732177734375\n ],\n \"_id\": \"9ba5fb10-c8db-11e9-8f2a-ada77612c97e\",\n \"created\": 1566918114625,\n \"number\": 1,\n \"thumbnail\": \"teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/issues/9ba5fb10-c8db-11e9-8f2a-ada77612c97e/thumbnail.png\",\n \"typePrefix\": \"Structural\",\n \"modelCode\": \"\",\n \"account\": \"teamSpace1\",\n \"model\": \"3549ddf6-885d-4977-87f1-eeac43a0e818\",\n \"viewpoint\": {\n \"right\": [\n 0.8471935391426086,\n -2.2351741790771484e-8,\n 0.5312844514846802\n ],\n \"up\": [\n 0.14098820090293884,\n 0.9641460180282593,\n -0.22482173144817352\n ],\n \"position\": [\n -5828.818359375,\n 5268.15625,\n 7829.76171875\n ],\n \"look_at\": [\n -2445.6826171875,\n 3515.4658203125,\n 2434.966552734375\n ],\n \"view_dir\": [\n 0.5122357606887817,\n -0.2653723657131195,\n -0.8168182373046875\n ],\n \"near\": 20.835742950439453,\n \"far\": 10417.87109375,\n \"fov\": 1.0471975803375244,\n \"aspect_ratio\": 4.031496047973633,\n \"clippingPlanes\": [],\n \"hidden_group_id\": \"119d5dc0-e223-11ea-8549-49012d4e4956\",\n \"highlighted_group_id\" : \"80c5a270-e223-11ea-8549-49012d4e4956\",\n \"override_group_ids\": [\n \"11952060-e223-11ea-8549-49012d4e4956\",\n \"bc5ca80-e6c7-11ea-bd51-ddd919e6418e\"\n ],\n \"transformation_group_ids\": [\n \"12345678-e223-11ea-8549-49012d4e4956\",\n \"12345678-e6c7-11ea-bd51-ddd919e6418e\"\n ],\n \"hideIfc\": true,\n \"screenshot\": \"teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/issues/9ba5fb10-c8db-11e9-8f2a-ada77612c97e/viewpoints/125ce196-852c-49ed-9a2f-f9a77aa03390/screenshot.png\",\n \"guid\": \"125ce196-852c-49ed-9a2f-f9a77aa03390\",\n \"screenshotSmall\": \"teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/issues/9ba5fb10-c8db-11e9-8f2a-ada77612c97e/viewpoints/125ce196-852c-49ed-9a2f-f9a77aa03390/screenshotSmall.png\"\n },\n \"comments\": [],\n \"extras\": {\n }\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues" + }, + { + "type": "post", + "url": "/:teamspace/:model/revision/:revId/issues", + "title": "Create issue on revision", + "name": "newIssueRev", + "group": "Issues", + "description": "

Creates a new issue for a particular revision. See here for more details.

", + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "revId", + "description": "

Revision ID

" + } + ] + } + } + }, + { + "type": "post", + "url": "/:teamspace/:model/revision/:revId/issues.bcfzip", + "title": "Post Issues BCF zip file by revision ID", + "name": "postIssuesBCF", + "group": "Issues", + "description": "

Upload Issues BCF file using current revision ID.

", + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "String", + "optional": false, + "field": "status", + "description": "

"ok" on success

" + } + ] + }, + "examples": [ + { + "title": "Success-Response:", + "content": "HTTP\n{\n\t\"status\":\"ok\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "revId", + "description": "

Revision ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/issues.html", + "title": "Issues response into as HTML", + "name": "renderIssuesHTML", + "group": "Issues", + "description": "

Render all Issues into a HTML webpage, response is rendered HTML.

", + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:revId/issues.html", + "title": "Issues response into as HTML by revision ID", + "name": "renderIssuesHTMLRid", + "group": "Issues", + "description": "

Render all Issues into a HTML webpage based on current revision ID.

", + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "revId", + "description": "

Revision ID

" + } + ] + } + } + }, + { + "type": "patch", + "url": "/:teamspace/:model/issues/:issueId", + "title": "Update issue", + "name": "updateIssue", + "group": "Issues", + "description": "

Updates an issue. It takes the part of the issue that can be updated. The system will create a system comment within the issue describing which values were changed. The user needs to be the teamspace administrator, the project administrator, has the same job as the creator of the issue, or has the issue assigned. In the case that the issue has been assigned to the user, the user cannot change it to the "closed" status.

If the issue is being updated to assigned to a job and the status of the issue has the value "for_approval", then the status of the issue is automatically changed to "in_progress".

If the user is changing the issue to the "for_approval" status, the issue will be assigned to the job that the creator of the issue.

", + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "[]String", + "optional": true, + "field": "assigned_roles", + "description": "

Job roles assigned to the issue

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "desc", + "description": "

Description of issue

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "status", + "description": "

The status of issue (values: "open", "in progress", "for approval", "closed")

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "topic_type", + "description": "

Topic type of issue (see here for available types)

" + }, + { + "group": "Request body", + "type": "[3]Number", + "optional": true, + "field": "position", + "description": "

Vector defining the pin position of the issue; empty if the issue has no pin

" + }, + { + "group": "Request body", + "type": "Number", + "optional": true, + "field": "due_date", + "description": "

Due date timestamp for the issue

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "priority", + "description": "

The priority of the issue (values: "none", "low", "medium", "high")

" + }, + { + "group": "Request body", + "type": "Number", + "optional": true, + "field": "scale", + "description": "

The scale factor of the issue

" + }, + { + "group": "Request body", + "type": "Viewpoint", + "optional": true, + "field": "viewpoint", + "description": "

The viewpoint and screenshot of the issue

" + }, + { + "group": "Request body", + "type": "Number", + "optional": true, + "field": "viewCount", + "description": "

The viewcount of the issue

" + }, + { + "group": "Request body", + "type": "Object", + "optional": true, + "field": "extras", + "description": "

A field containing any extras that wanted to be saved in the issue (typically used by BCF)

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "issueId", + "description": "

Issue ID

" + } + ], + "Type: Viewpoint": [ + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "right", + "description": "

Right vector of viewpoint indicating the direction of right in relative coordinates

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "up", + "description": "

Up vector of viewpoint indicating the direction of up in relative coordinates

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "position", + "description": "

Position vector indicates where in the world the viewpoint is positioned

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "look_at", + "description": "

Vector indicating where in the world the viewpoint is looking at

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "view_dir", + "description": "

Vector indicating the direction the viewpoint is looking at in relative coordinates

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "near", + "description": "

Vector indicating the near plane

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "far", + "description": "

Vector indicating the far plane

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "fov", + "description": "

Angle of the field of view

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "aspect_ratio", + "description": "

Aspect ratio of the fustrum

" + }, + { + "group": "Type: Viewpoint", + "type": "ClippingPlane[]", + "optional": true, + "field": "clippingPlanes", + "description": "

Clipping planes associated with the viewpoint

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": true, + "field": "highlighted_group_id", + "description": "

If the viewpoint is associated with one or more highlighted objects from the model this field has the value of a group ID generated to hold those objects

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": true, + "field": "hidden_group_id", + "description": "

If the viewpoint is associated with one or more hidden objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": true, + "field": "shown_group_id", + "description": "

If the viewpoint is associated with one or more shown objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: Viewpoint", + "type": "Group", + "optional": true, + "field": "highlighted_group", + "description": "

If the viewpoint is associated with one or more highlighted objects from the model this field has the value of a group definition for those objects (this shouldnt be use simultaneously with highlighted_group_id)

" + }, + { + "group": "Type: Viewpoint", + "type": "Group", + "optional": true, + "field": "hidden_group", + "description": "

If the viewpoint is associated with one or more hidden objects from the model this field has the value of a group id generated to hold those objects (this shouldnt be use simultaneously with hidden_group_id)

" + }, + { + "group": "Type: Viewpoint", + "type": "Group", + "optional": true, + "field": "shown_group", + "description": "

If the viewpoint is associated with one or more shown objects from the model this field has the definition of the group to hold those objects (this shouldnt be use simultaneously with shown_group_id)

" + }, + { + "group": "Type: Viewpoint", + "type": "Group[]", + "optional": true, + "field": "override_groups", + "description": "

If the viewpoint has one or more objects with colour override this field has an array of groups with one group for each colour

" + }, + { + "group": "Type: Viewpoint", + "type": "Group[]", + "optional": true, + "field": "transformation_groups", + "description": "

List of groups with transformations

" + }, + { + "group": "Type: Viewpoint", + "type": "String[]", + "optional": true, + "field": "transformation_group_ids", + "description": "

List of group IDs with transformations

" + }, + { + "group": "Type: Viewpoint", + "type": "Boolean", + "optional": false, + "field": "hide_IFC", + "description": "

A flag to hide the IFC

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": false, + "field": "screenshot", + "description": "

Base64 string representing the screenshot associated with the viewpoint

" + } + ], + "Type: Group": [ + { + "group": "Type: Group", + "type": "Number[3]", + "optional": false, + "field": "color", + "description": "

RGB colour values

" + }, + { + "group": "Type: Group", + "type": "ModelObjects", + "optional": false, + "field": "objects", + "description": "

List of objects in group

" + } + ], + "Type: ModelObjects": [ + { + "group": "Type: ModelObjects", + "type": "String", + "optional": false, + "field": "account", + "description": "

The account that has the model which contains the objects

" + }, + { + "group": "Type: ModelObjects", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model id that contains the objects

" + }, + { + "group": "Type: ModelObjects", + "type": "String[]", + "optional": false, + "field": "shared_ids", + "description": "

The shared ids of objects to be selected

" + } + ], + "Type: ClippingPlane": [ + { + "group": "Type: ClippingPlane", + "type": "Number[3]", + "optional": false, + "field": "normal", + "description": "

The normal of the plane defined for the clipping plane

" + }, + { + "group": "Type: ClippingPlane", + "type": "Number", + "optional": false, + "field": "distance", + "description": "

The distance for the clipping plane to the origin

" + }, + { + "group": "Type: ClippingPlane", + "type": "Number", + "optional": false, + "field": "clipDirection", + "description": "

The direction to the clipping plane will cut the model; above or below the plane. Possible values: 1 , -1.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "PATCH /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/issues/98c39770-c8e2-11e9-8f2a-ada77612c97e HTTP/1.1\n{\"status\":\"in progress\"}", + "type": "patch" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n \"_id\": \"98c39770-c8e2-11e9-8f2a-ada77612c97e\",\n \"name\": \"issue 2\",\n \"assigned_roles\": [\n \"jobC\"\n ],\n \"status\": \"in progress\",\n \"priority\": \"none\",\n \"topic_type\": \"for_information\",\n \"owner\": \"teamSpace1\",\n \"rev_id\": \"330f909b-9279-41aa-a87c-1c46f53a8e93\",\n \"creator_role\": \"jobA\",\n \"scale\": 1,\n \"created\": 1566921116263,\n \"desc\": \"(No Description)\",\n \"number\": 2,\n \"thumbnail\": \"teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/issues/98c39770-c8e2-11e9-8f2a-ada77612c97e/thumbnail.png\",\n \"comments\": [\n {\n \"guid\": \"febbe083-5a98-4711-8d60-d2ac06721f83\",\n \"created\": 1566924049774,\n \"owner\": \"teamSpace1\",\n \"action\": {\n \"property\": \"assigned_roles\",\n \"from\": \"\",\n \"to\": \"jobB\"\n },\n \"sealed\": true\n },\n {\n \"guid\": \"e8ba32b2-d58e-4c33-90f7-c6e0404ef1ee\",\n \"created\": 1566924062287,\n \"owner\": \"teamSpace1\",\n \"action\": {\n \"property\": \"assigned_roles\",\n \"from\": \"jobB\",\n \"to\": \"jobC\"\n },\n \"sealed\": true\n },\n {\n \"guid\": \"83117273-2698-4d2d-bd47-7cd31e6a7b14\",\n \"created\": 1566924080277,\n \"owner\": \"teamSpace1\",\n \"action\": {\n \"property\": \"status\",\n \"from\": \"open\",\n \"to\": \"in progress\"\n }\n }\n ],\n \"status_last_changed\": 1566924080277,\n \"account\": \"teamSpace1\",\n \"model\": \"3549ddf6-885d-4977-87f1-eeac43a0e818\",\n \"viewpoint\": {\n \"right\": [\n 0.9953137040138245,\n -4.656612873077393e-10,\n 0.09669896215200424\n ],\n \"up\": [\n 0.005437099374830723,\n 0.9984180331230164,\n -0.05596357211470604\n ],\n \"position\": [\n -3083.33251953125,\n 3886.8251953125,\n 8998.2783203125\n ],\n \"look_at\": [\n -2445.680419921875,\n 3515.46533203125,\n 2434.984130859375\n ],\n \"view_dir\": [\n 0.0965459868311882,\n -0.05622706934809685,\n -0.9937390685081482\n ],\n \"near\": 20.835796356201172,\n \"far\": 10417.8984375,\n \"fov\": 1.0471975803375244,\n \"aspect_ratio\": 3.1459293365478516,\n \"clippingPlanes\": [],\n \"highlighted_group_id\": \"98b9d370-c8e2-11e9-8f2a-ada77612c97e\",\n \"hideIfc\": true,\n \"screenshot\": \"teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/issues/98c39770-c8e2-11e9-8f2a-ada77612c97e/viewpoints/a1167d5f-2434-4a50-a158-d6a6745e7d6a/screenshot.png\",\n \"guid\": \"a1167d5f-2434-4a50-a158-d6a6745e7d6a\",\n \"screenshotSmall\": \"teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/issues/98c39770-c8e2-11e9-8f2a-ada77612c97e/viewpoints/a1167d5f-2434-4a50-a158-d6a6745e7d6a/screenshotSmall.png\"\n },\n \"position\": [],\n \"extras\": {\n }\n}", + "type": "json" + } + ], + "fields": { + "200": [ + { + "group": "200", + "type": "Object", + "optional": false, + "field": "Updated", + "description": "

Issue Object.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues" + }, + { + "type": "patch", + "url": "/:teamspace/:model/revision/:revId/issues/:issueId", + "title": "Update issue on revision", + "name": "updateIssueRev", + "group": "Issues", + "description": "

Updates an issue for a particular revision. See here for more details.

", + "version": "0.0.0", + "filename": "src/v4/routes/issue.js", + "groupTitle": "Issues", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "issueId", + "description": "

Issue ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "revId", + "description": "

Revision ID

" + } + ] + } + } + }, + { + "type": "post", + "url": "/:teamspace/jobs/:jobId/:user", + "title": "Assign a job", + "name": "addUserToJob", + "group": "Jobs", + "description": "

Assign a job to a user.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "optional": false, + "field": "jobId", + "description": "

Job ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user", + "description": "

User

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /acme/jobs/Job1/alice HTTP/1.1", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/job.js", + "groupTitle": "Jobs" + }, + { + "type": "post", + "url": "/:teamspace/jobs", + "title": "Create a new job", + "name": "createJob", + "group": "Jobs", + "description": "

Create a new job on teamspace.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "_id", + "description": "

Name of job

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "color", + "description": "

Colour of job

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "success": { + "fields": { + "Job object": [ + { + "group": "Job object", + "type": "String", + "optional": false, + "field": "_id", + "description": "

Name of job

" + }, + { + "group": "Job object", + "type": "String", + "optional": false, + "field": "color", + "description": "

Colour of job

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t_id:\"Job4\",\n\tcolor:\"#ffff00\"\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /acme/jobs HTTP/1.1\n{\n\t_id:\"Job4\",\n\tcolor:\"#ffff00\"\n}", + "type": "post" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/job.js", + "groupTitle": "Jobs" + }, + { + "type": "delete", + "url": "/:teamspace/jobs/:jobId", + "title": "Delete a job", + "name": "deleteJob", + "group": "Jobs", + "description": "

Delete a job from teamspace.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "jobId", + "description": "

Job ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "DELETE /acme/jobs/Job 1 HTTP/1.1", + "type": "delete" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/job.js", + "groupTitle": "Jobs" + }, + { + "type": "get", + "url": "/:teamspace/myJob", + "title": "Get user job", + "name": "getUserJob", + "group": "Jobs", + "description": "

Get job assigned to current user.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/myJob HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t_id\":\"Job1\",\n\t\"color\":\"ff00000\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/job.js", + "groupTitle": "Jobs", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/jobs/colors", + "title": "List colours", + "name": "listColors", + "group": "Jobs", + "description": "

List job colours.

", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "String[]", + "optional": false, + "field": "colors", + "description": "

List of job colours

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n[\n\t\"#ff0000\",\n\t\"#00ff00\",\n\t\"#0000ff\"\n]", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/jobs/colors HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/job.js", + "groupTitle": "Jobs", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/jobs", + "title": "List all jobs", + "name": "listJobs", + "group": "Jobs", + "description": "

List of all jobs defined in teamspace.

", + "success": { + "fields": { + "Job object": [ + { + "group": "Job object", + "type": "String", + "optional": false, + "field": "_id", + "description": "

Name of job

" + }, + { + "group": "Job object", + "type": "String", + "optional": false, + "field": "color", + "description": "

Colour of job

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"_id\":\"Job1\",\n\t\t\"color\":\"#ff0000\"\n\t},\n\t{\n\t\t\"_id\":\"Job2\",\n\t\t\"color\":\"#00ff00\"\n\t},\n\t{\n\t\t\"_id\":\"Job3\",\n\t\t\"color\":\"#0000ff\"\n\t}\n]", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/jobs HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/job.js", + "groupTitle": "Jobs", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + } + }, + { + "type": "put", + "url": "/:teamspace/jobs/:jobId", + "title": "Update job", + "name": "updateJob", + "group": "Jobs", + "description": "

Update job.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "jobId", + "description": "

Job ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "_id", + "description": "

Name of job

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "color", + "description": "

Colour of job

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "PUT /acme/jobs/Job1 HTTP/1.1\n{\n\t_id:\"Renamed Job\",\n\tcolor:\"#00ffff\"\n}", + "type": "put" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/job.js", + "groupTitle": "Jobs" + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/hereadminlabeloverlay/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here admin layer", + "name": "getHereAdminOverlayTile", + "group": "Maps", + "description": "

Retrieve a Here Maps administrative labels overlay tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/hereadminlabeloverlay/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/hereaerial/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here aerial tile", + "name": "getHereAerialMapsTile", + "group": "Maps", + "description": "

Retrieve a Here Maps aerial map tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/hereaerial/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/hereinfo", + "title": "Here Maps options", + "name": "getHereBaseInfo", + "group": "Maps", + "description": "

Get Here Maps service options.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/ HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n\n\t\n\t\t\n\t\n\t\n\t\t\n\t\n\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\n\t\n", + "type": "xml" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/herebuildings/:lat/:long/tile.json", + "title": "Here building elevation", + "name": "getHereBuildingsFromLongLat", + "group": "Maps", + "description": "

Retrieve building elevation information from Here Maps.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "lat", + "description": "

Latitude

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "long", + "description": "

Longitude

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/herebuildings/51.524575/-0.139088/tile.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"Rows\":[\n\t\t{\n\t\t\t\"BUILDING_ID\":\"700567270\",\n\t\t\t\"FACE_ID\":\"700567270\",\n\t\t\t\"FEATURE_TYPE\":\"2005700\",\n\t\t\t\"HEIGHT\":\"22\",\n\t\t\t\"GROUND_CLEARANCE\":null,\n\t\t\t\"CF_ID\":\"1400645341\",\n\t\t\t\"HAS_3DLM\":\"N\",\n\t\t\t\"NAME\":null,\n\t\t\t\"LAT\":\"5150745,9,-12,-4,10,-5,2\",\n\t\t\t\"LON\":\"-14284,18,14,-9,-12,-9,-2\",\n\t\t\t\"INNER_LAT\":null,\n\t\t\t\"INNER_LON\":null\n\t\t},\n\t\t{\n\t\t\t\"BUILDING_ID\":\"700567273\",\n\t\t\t\"FACE_ID\":\"700567273\",\n\t\t\t\"FEATURE_TYPE\":\"2005700\",\n\t\t\t\"HEIGHT\":\"11\",\n\t\t\t\"GROUND_CLEARANCE\":null,\n\t\t\t\"CF_ID\":\"1400645344\",\n\t\t\t\"HAS_3DLM\":\"N\",\n\t\t\t\"NAME\":null,\n\t\t\t\"LAT\":\"5150742,-12,-4,-4,11,5,4\",\n\t\t\t\"LON\":\"-14252,14,-9,-8,-14,8,9\",\n\t\t\t\"INNER_LAT\":null,\n\t\t\t\"INNER_LON\":null\n\t\t}\n\t]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

" + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/heregrey/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here grey tile", + "name": "getHereGreyTile", + "group": "Maps", + "description": "

Retrieve a Here Maps grey map tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/heregrey/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/heregreytransit/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here transit (grey) tile", + "name": "getHereGreyTransitTile", + "group": "Maps", + "description": "

Retrieve a Here Maps grey transit map tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/heregreytransit/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/herehybrid/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here hybrid tile", + "name": "getHereHybridTile", + "group": "Maps", + "description": "

Retrieve a Here Maps hybrid map tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/herehybrid/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/herelabeloverlay/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here label layer", + "name": "getHereLabelOverlayTile", + "group": "Maps", + "description": "

Retrieve a Here Maps label overlay tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/herelabeloverlay/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/herelinelabeloverlay/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here line & label layer", + "name": "getHereLineLabelOverlayTile", + "group": "Maps", + "description": "

Retrieve a Here Maps line and label overlay tile image of street lines, city centre labels, and item labels.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/herelinelabeloverlay/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/here/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here map tile", + "name": "getHereMapsTile", + "group": "Maps", + "description": "

Retrieve a Here Maps map tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/here/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/herepoi/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here POI tile", + "name": "getHerePOITile", + "group": "Maps", + "description": "

Retrieve a Here Maps point-of-interest (POI) map tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/herepoi/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/hereterrain/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here terrain tile", + "name": "getHereTerrainTile", + "group": "Maps", + "description": "

Retrieve a Here Maps terrain map tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/hereterrain/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/heretollzone/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here toll zone tile", + "name": "getHereTollZoneTile", + "group": "Maps", + "description": "

Retrieve a Here Maps toll zone map tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/heretollzone/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/heretrafficflow/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here traffic layer", + "name": "getHereTrafficFlowTile", + "group": "Maps", + "description": "

Retrieve a Here Maps traffic flow overlay tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/heretrafficflow/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "min_traffic_congestion", + "description": "

Specifies the minimum traffic congestion level to use for rendering traffic flow (free, heavy, queuing, blocked)

" + }, + { + "group": "Query", + "type": "DateTime", + "optional": true, + "field": "time", + "description": "

Date and time for showing historical traffic patterns

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/heretraffic/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here traffic tile", + "name": "getHereTrafficTile", + "group": "Maps", + "description": "

Retrieve a Here Maps traffic map tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/heretraffic/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "min_traffic_congestion", + "description": "

Specifies the minimum traffic congestion level to use for rendering traffic flow (free, heavy, queuing, blocked)

" + }, + { + "group": "Query", + "type": "DateTime", + "optional": true, + "field": "time", + "description": "

Date and time for showing historical traffic patterns

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/heretruckoverlay/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here truck restrictions layer", + "name": "getHereTruckRestrictionsOverlayTile", + "group": "Maps", + "description": "

Retrieve a Here Maps truck restrictions overlay tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/heretruckoverlay/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/heretruck/:zoomLevel/:gridx/:gridy.png?[query]", + "title": "Here truck restrictions tile", + "name": "getHereTruckRestrictionsTile", + "group": "Maps", + "description": "

Retrieve a Here Maps truck restrictions map tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/heretruck/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "congestion", + "description": "

Flag that enables congestion and environmental zone display

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg", + "description": "

MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "lg2", + "description": "

Secondary MARC three-letter language code for labels

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pois", + "description": "

Mask for Here Maps POIs categories

" + }, + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "ppi", + "description": "

Tile resolution in pixels per inch (72, 250, 320, 500)

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "pview", + "description": "

Render map boundaries based on internal or local views

" + }, + { + "group": "Query", + "type": "String", + "optional": true, + "field": "style", + "description": "

Select style used to render map tile

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps/osm/:zoomLevel/:gridx/:gridy.png", + "title": "OSM map tile", + "name": "getOSMTile", + "group": "Maps", + "description": "

Retrieve an Open Street Map (OSM) map tile image.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps/osm/17/65485/43574.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "zoomLevel", + "description": "

Zoom level

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridx", + "description": "

Longitudinal (X) grid reference

" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "gridy", + "description": "

Latitudinal (Y) grid reference

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Map tile image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/:model/maps", + "title": "List maps", + "name": "listMaps", + "group": "Maps", + "description": "

List the available geographic information system (GIS) sources and map layers.

", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Object[]", + "optional": false, + "field": "maps", + "description": "

List of available map objects

" + } + ], + "Map object": [ + { + "group": "Map object", + "type": "String", + "optional": false, + "field": "name", + "description": "

Name of map provider

" + }, + { + "group": "Map object", + "type": "Object[]", + "optional": false, + "field": "layers", + "description": "

List of available map layer objects

" + } + ], + "Layer object": [ + { + "group": "Layer object", + "type": "String", + "optional": false, + "field": "name", + "description": "

Name of map layer

" + }, + { + "group": "Layer object", + "type": "String", + "optional": false, + "field": "source", + "description": "

Map source identifier

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"maps\":[\n\t\t{\n\t\t\t\"name\":\"Open Street Map\",\n\t\t\t\"layers\":[\n\t\t\t\t{\n\t\t\t\t\t\"name\":\"Map Tiles\",\n\t\t\t\t\t\"source\":\"OSM\"\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"name\":\"Here\",\n\t\t\t\"layers\":[\n\t\t\t\t{\n\t\t\t\t\t\"name\":\"Map Tiles\",\n\t\t\t\t\t\"source\":\"HERE\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"name\":\"Traffic Flow\",\n\t\t\t\t\t\"source\":\"HERE_TRAFFIC_FLOW\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"name\":\"Truck Restrictions\",\n\t\t\t\t\t\"source\":\"HERE_TRUCK_OVERLAY\"\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t]\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/maps HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/maps.js", + "groupTitle": "Maps", + "groupDescription": "

Geographic information system (GIS) resources from Open Street Maps (OSM) and Here are supported. Please note that an app_id and app_code from Here are required to access Here resources.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/meta/4DTaskSequence.json", + "title": "Get All metadata for 4D Sequence Tags", + "name": "getAllIdsWith4DSequenceTag", + "group": "Meta", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/meta.js", + "groupTitle": "Meta" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:rev/meta/4DTaskSequence.json", + "title": "Get All metadata with 4D Sequence Tags by revision", + "name": "getAllIdsWith4DSequenceTagRev", + "group": "Meta", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

Revision

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/meta.js", + "groupTitle": "Meta" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/meta/all.json?filter=:filter", + "title": "Get all metadata", + "name": "getAllMetadata", + "group": "Meta", + "description": "

Get all objects in the tree with their metadata.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "filter", + "description": "

(optional) properties to filter for, comma separated

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/revision/master/head/meta/all.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n \"data\": [\n {\n \"_id\": \"2f461edf-4544-412a-bb84-ffdb3bbe563b\",\n \"metadata\": {\n \"IFC Type\": \"IfcBuilding\",\n \"IFC GUID\": \"00tMo7QcxqWdIGvc4sMN2A\",\n \"BuildingID\": \"n/a\",\n \"IsPermanentID\": \"True\",\n \"OccupancyType\": \"Private dwelling\",\n \"IsLandmarked\": \"True\",\n \"NumberOfStoreys\": 2\n },\n \"parents\": [\n \"9eeddbe2-750d-46fb-988f-bcf9ec2ecf51\"\n ]\n },\n {\n \"_id\": \"85ad29bd-cd99-4472-a92f-86266b07e57d\",\n \"metadata\": {\n \"IFC Type\": \"IfcSite\",\n \"IFC GUID\": \"20FpTZCqJy2vhVJYtjuIce\"\n },\n \"parents\": [\n \"48359ad0-9b6d-44ed-ae93-47e2ec69ea88\"\n ]\n },\n {\n \"_id\": \"b5fe5dcf-ce8c-4b1e-a96b-bdc5aa001963\",\n \"metadata\": {\n \"IFC Type\": \"IfcBuildingElementProxy\",\n \"IFC GUID\": \"3VkTAO0fr0XQHS3DxQzfxm\",\n \"Reference\": \"LegoRoundTree\"\n },\n \"parents\": [\n \"2bf2a864-5cb0-41ba-85a8-c2cffc3da06d\"\n ]\n },\n {\n \"_id\": \"c4682cf2-7b2a-41c7-8fe2-c0c39512dd99\",\n \"metadata\": {\n \"IFC Type\": \"IfcBuildingStorey\",\n \"IFC GUID\": \"1oZ0wPs_PE8ANCPg3bIs4j\",\n \"AboveGround\": \"False\"\n },\n \"parents\": [\n \"323a9900-ece1-4857-8980-ec96ffc7f681\"\n ]\n }\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/meta.js", + "groupTitle": "Meta" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:rev/meta/all.json?filter=:filter", + "title": "Get all metadata by revision", + "name": "getAllMetadataByRev", + "group": "Meta", + "description": "

Get all tree objects with their metadata tags by revision. See more details here.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

Revision to get metadata from

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "filter", + "description": "

(optional) properties to filter for, comma separated

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/meta.js", + "groupTitle": "Meta" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/meta/findObjsWith/:metaKey.json", + "title": "Get ids by metadata", + "name": "getIdsWithMetadataField", + "group": "Meta", + "description": "

Get ids of tree objects which has a particular metadata key (in the latest revision). It also returns the metadata value for that key.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "metaKey", + "description": "

Unique metadata key

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/revision/master/head/meta/findObjsWith/IsLandmarked.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n \"data\": [\n {\n \"_id\": \"2f461edf-4544-412a-bb84-ffdb3bbe563b\",\n \"metadata\": {\n \"value\": \"True\"\n },\n \"parents\": [\n \"9eeddbe2-750d-46fb-988f-bcf9ec2ecf51\"\n ]\n }\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/meta.js", + "groupTitle": "Meta" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:rev/meta/findObjsWith/:metaKey.json", + "title": "Get ids by metadata", + "name": "getIdsWithMetadataFieldByRev", + "group": "Meta", + "description": "

Get ids of tree objects which has a particular metadata key from a particular revision. See more details here.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

Revision to get metadata from

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "metaKey", + "description": "

Unique meta key

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/meta.js", + "groupTitle": "Meta" + }, + { + "type": "get", + "url": "/:teamspace/:model/meta/:id.json", + "title": "Get metadata", + "name": "getMetadataById", + "group": "Meta", + "description": "

Get all metadata tags by revision. See more details here.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "optional": false, + "field": "id", + "description": "

Meta Unique ID

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/meta/b5fe5dcf-ce8c-4b1e-a96b-bdc5aa001963.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n \"meta\": [\n {\n \"_id\": \"b5fe5dcf-ce8c-4b1e-a96b-bdc5aa001963\",\n \"name\": \"LegoRoundTree:LegoRoundTree:302403\",\n \"metadata\": {\n \"IFC Type\": \"IfcBuildingElementProxy\",\n \"IFC GUID\": \"3VkTAO0fr0XQHS3DxQzfxm\",\n \"Reference\": \"LegoRoundTree\"\n }\n }\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/meta.js", + "groupTitle": "Meta" + }, + { + "type": "get", + "url": "/:teamspace/:model/meta/keys", + "title": "Get array of metadata fields", + "name": "getMetadataFields", + "group": "Meta", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/meta/keys HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "[\n \"AboveGround\",\n \"BuildingID\",\n \"IFC GUID\",\n \"IFC Type\",\n \"IsLandmarked\",\n \"IsPermanentID\",\n \"NumberOfStoreys\",\n \"OccupancyType\",\n \"Reference\"\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/meta.js", + "groupTitle": "Meta" + }, + { + "type": "post", + "url": "/:teamspace/:model/revision(/master/head/|/:revId)/meta/rules?filter=:filter", + "title": "Filter metadata by rules", + "name": "queryMetadataByRules", + "group": "Meta", + "description": "

Get all objects matching filter rules in the tree with their metadata.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "filter", + "description": "

(optional) properties to filter for, comma separated

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Boolean", + "optional": true, + "field": "meshids", + "description": "

Flag that returns Mesh IDs for matching rule queries

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage (/master/head)", + "content": "POST /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/revision/master/head/meta/rules HTTP/1.1\n[\n\t{\n\t\t\"field\":\"Area\",\n\t\t\"operator\":\"GT\",\n\t\t\"values\":[5]\n\t},\n\t{\n\t\t\"field\":\"IFC Type\",\n\t\t\"operator\":\"IS\",\n\t\t\"values\":[\n\t\t\t\"IfcWall\",\n\t\t\t\"IfcDoor\"\n\t\t]\n\t}\n]", + "type": "post" + }, + { + "title": "Example usage (/:revId)", + "content": "POST /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/revision/00000000-0000-0000-0000-000000000001/meta/rules HTTP/1.1", + "type": "post" + }, + { + "title": "Example usage (mesh IDs)", + "content": "POST /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/revision/master/head/meta/rules?meshids=true HTTP/1.1", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success (metadata):", + "content": "{\n \"data\": [\n {\n \"_id\": \"2f461edf-4544-412a-bb84-ffdb3bbe563b\",\n \"metadata\": {\n \"IFC Type\": \"IfcBuilding\",\n \"IFC GUID\": \"00tMo7QcxqWdIGvc4sMN2A\",\n \"BuildingID\": \"n/a\",\n \"IsPermanentID\": \"True\",\n \"OccupancyType\": \"Private dwelling\",\n \"IsLandmarked\": \"True\",\n \"Area\": 9000,\n \"NumberOfStoreys\": 2\n },\n \"parents\": [\n \"9eeddbe2-750d-46fb-988f-bcf9ec2ecf51\"\n ]\n },\n {\n \"_id\": \"85ad29bd-cd99-4472-a92f-86266b07e57d\",\n \"metadata\": {\n \"IFC Type\": \"IfcWall\",\n \"IFC GUID\": \"20FpTZCqJy2vhVJYtjuIce\"\n },\n \"parents\": [\n \"48359ad0-9b6d-44ed-ae93-47e2ec69ea88\"\n ]\n },\n {\n \"_id\": \"b5fe5dcf-ce8c-4b1e-a96b-bdc5aa001963\",\n \"metadata\": {\n \"IFC Type\": \"IfcBuildingElementProxy\",\n \"IFC GUID\": \"3VkTAO0fr0XQHS3DxQzfxm\",\n \"Area\": 6,\n \"Reference\": \"LegoRoundTree\"\n },\n \"parents\": [\n \"2bf2a864-5cb0-41ba-85a8-c2cffc3da06d\"\n ]\n },\n {\n \"_id\": \"c4682cf2-7b2a-41c7-8fe2-c0c39512dd99\",\n \"metadata\": {\n \"IFC Type\": \"IfcDoor\",\n \"IFC GUID\": \"1oZ0wPs_PE8ANCPg3bIs4j\",\n \"AboveGround\": \"False\"\n },\n \"parents\": [\n \"323a9900-ece1-4857-8980-ec96ffc7f681\"\n ]\n }\n ]\n}", + "type": "json" + }, + { + "title": "Success (federation metadata):", + "content": "{\n \"data\": [],\n \"subModels\": [\n {\n \"data\": [\n {\n \"_id\": \"2f461edf-4544-412a-bb84-ffdb3bbe563b\",\n \"metadata\": {\n \"IFC Type\": \"IfcBuilding\",\n \"IFC GUID\": \"00tMo7QcxqWdIGvc4sMN2A\",\n \"BuildingID\": \"n/a\",\n \"IsPermanentID\": \"True\",\n \"OccupancyType\": \"Private dwelling\",\n \"IsLandmarked\": \"True\",\n \"Area\": 9000,\n \"NumberOfStoreys\": 2\n },\n \"parents\": [\n \"9eeddbe2-750d-46fb-988f-bcf9ec2ecf51\"\n ]\n },\n {\n \"_id\": \"85ad29bd-cd99-4472-a92f-86266b07e57d\",\n \"metadata\": {\n \"IFC Type\": \"IfcWall\",\n \"IFC GUID\": \"20FpTZCqJy2vhVJYtjuIce\"\n },\n \"parents\": [\n \"48359ad0-9b6d-44ed-ae93-47e2ec69ea88\"\n ]\n },\n {\n \"_id\": \"b5fe5dcf-ce8c-4b1e-a96b-bdc5aa001963\",\n \"metadata\": {\n \"IFC Type\": \"IfcBuildingElementProxy\",\n \"IFC GUID\": \"3VkTAO0fr0XQHS3DxQzfxm\",\n \"Area\": 6,\n \"Reference\": \"LegoRoundTree\"\n },\n \"parents\": [\n \"2bf2a864-5cb0-41ba-85a8-c2cffc3da06d\"\n ]\n },\n {\n \"_id\": \"c4682cf2-7b2a-41c7-8fe2-c0c39512dd99\",\n \"metadata\": {\n \"IFC Type\": \"IfcDoor\",\n \"IFC GUID\": \"1oZ0wPs_PE8ANCPg3bIs4j\",\n \"AboveGround\": \"False\"\n },\n \"parents\": [\n \"323a9900-ece1-4857-8980-ec96ffc7f681\"\n ]\n }\n ],\n \"account\": \"acme\",\n \"model\": \"00000000-0000-0000-0000-000000000001\"\n },\n {\n \"data\": [\n {\n \"_id\": \"2f461edf-4544-412a-bb84-ffdb3bbe563b\",\n \"metadata\": {\n \"IFC Type\": \"IfcBuilding\",\n \"IFC GUID\": \"12tTo3QcxqWd5Gvc4sABCA\",\n \"BuildingID\": \"Site B\",\n \"IsPermanentID\": \"True\",\n \"OccupancyType\": \"Private dwelling\",\n \"IsLandmarked\": \"True\",\n \"Area\": 20,\n \"NumberOfStoreys\": 1\n },\n \"parents\": [\n \"9eeddbe2-750d-46fb-988f-bcf9ec2ecf51\"\n ]\n }\n ],\n \"account\": \"acme\",\n \"model\": \"00000000-0000-0000-0000-000000000002\"\n }\n ]\n}", + "type": "json" + }, + { + "title": "Success (mesh IDs):", + "content": "[\n\t{\n\t\t\"account\": \"acme\",\n\t\t\"model\": \"00000000-0000-0000-0000-000000000000\",\n\t\t\"mesh_ids\": [\n\t\t\t\"11111111-1111-1111-1111-111111111111\",\n\t\t\t\"22222222-2222-2222-2222-222222222222\",\n\t\t\t\"33333333-3333-3333-3333-333333333333\",\n\t\t\t\"44444444-4444-4444-4444-444444444444\"\n\t\t]\n\t}\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/meta.js", + "groupTitle": "Meta" + }, + { + "type": "patch", + "url": "/:teamspace/models/permissions", + "title": "Batch update model permissions", + "name": "batchUpdateModelPermissions", + "group": "Model", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace.

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "ModelPermissions[]", + "optional": false, + "field": "BODY", + "description": "

List of model permissions

" + } + ], + "Request body: ModelPermissions": [ + { + "group": "Request body: ModelPermissions", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Request body: ModelPermissions", + "type": "Permission[]", + "optional": false, + "field": "permissions", + "description": "

List of user permissions

" + } + ], + "Request body: Permission": [ + { + "group": "Request body: Permission", + "type": "string", + "optional": false, + "field": "user", + "description": "

User ID

" + }, + { + "group": "Request body: Permission", + "type": "string", + "optional": false, + "field": "permission", + "description": "

Permission type ('viewer'|'commenter'|'collaborator'|'').

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "PATCH /acme/models/permissions HTTP/1.1\n[\n {\n model: \"00000000-0000-0000-0000-000000000000\",\n permissions: [\n {\n user: \"alice\",\n permission: \"collaborator\"\n },\n {\n user: \"bob\",\n permission: \"commenter\"\n },\n {\n user: \"mike\",\n permission: \"\"\n }\n ]\n },\n {\n model: \"11111111-1111-1111-1111-111111111111\",\n permissions: [\n {\n user: \"charlie\",\n permission: \"viewer\"\n }\n ]\n },\n {\n model: \"22222222-2222-2222-2222-222222222222\",\n permissions: [\n {\n user: \"dave\",\n permission: \"commenter\"\n },\n {\n user: \"eve\",\n permission: \"\"\n }\n ]\n }\n]", + "type": "patch" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n status: \"ok\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "post", + "url": "/:teamspace/model", + "title": "Create a model", + "name": "createModel", + "group": "Model", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "project", + "description": "

Name of project in which the model will be created

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "modelName", + "description": "

Name of the model to be created

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "unit", + "description": "

The unit in which the model is specified

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "desc", + "description": "

A description of the model

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "code", + "description": "

A code to be associated with the model; it can be of maximum 5 letters (a-z) and numbers

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "type", + "description": "

The type of the model

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /teamSpace1/model HTTP/1.1\n{\n project: \"classic project\",\n modelName: \"awesomeModel\",\n unit: \"ft\",\n desc: \"This is an awesome model!\",\n code: \"awe12\",\n type: \"Mechanical\"\n}", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n account: \"teamSpace1\",\n model: \"17d09947-368e-4748-877f-d105842c6681\",\n name: \"awesomeModel\",\n permissions: [\n \"change_model_settings\",\n \"upload_files\",\n \"create_issue\",\n \"comment_issue\",\n \"view_issue\",\n \"view_model\",\n \"download_model\",\n \"edit_federation\",\n \"delete_federation\",\n \"delete_model\",\n \"manage_model_permission\"\n ],\n setting: {\n type: \"Mechanical\",\n desc: \"\",\n name: \"awesomeModel\",\n _id: \"17d09947-368e-4748-877f-d105842c6681\",\n subModels: [],\n surveyPoints: [],\n properties: {\n unit: \"ft\"\n },\n permissions: [],\n status: \"ok\"\n }\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "delete", + "url": "/:teamspace/:model", + "title": "Delete Model.", + "name": "deleteModel", + "group": "Model", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to delete.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "DELETE /teamSpace1/17d09947-368e-4748-877f-d105842c6681 HTTP/1.1", + "type": "delete" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n \"account\": \"teamSpace1\",\n \"model\": \"17d09947-368e-4748-877f-d105842c6681\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/download/latest", + "title": "Download model", + "name": "downloadModel", + "group": "Model", + "description": "

It returns the model file using the latest revision.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to download.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/b1fceab8-b0e9-4e45-850b-b9888efd6521/download/latest HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success (with headers):", + "content": "\nHTTP/1.1 200 OK\nX-Powered-By: Express\nVary: Origin\nAccess-Control-Allow-Credentials: true\nContent-Length: 11964\nContent-Disposition: attachment;filename=3DrepoBIM_blocks.obj\nset-cookie: connect.sid=s%3Ax4mDfLE-NqmPUO5tSSxPAyMjgov6YRge.bVSUoML3obJNp1XuObpbtXY44RjgEhJtsTz%2FwhwIckE; Domain=local.3drepo.io; Path=/; Expires=Tue, 27 Aug 2019 12:18:34 GMT; HttpOnly\nDate: Tue, 27 Aug 2019 11:18:34 GMT\nConnection: keep-alive\n\n/***** FILE CONTENTS ******\\", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/settings/heliSpeed", + "title": "Get model heli speed", + "name": "getHeliSpeed", + "group": "Model", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

The modelId to get Heli speed for.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/settings/heliSpeed HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\"heliSpeed\":1}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/idMap.json", + "title": "Get ID map", + "name": "getIdMap", + "group": "Model", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model id to Get ID Map for.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage (federation):", + "content": "GET /teamSpace1/5ce7dd19-1252-4548-a9c9-4a5414f2e0c5/revision/master/head/idMap.json HTTP/1.1", + "type": "get" + }, + { + "title": "Example usage (model):", + "content": "GET /teamSpace1/b1fceab8-b0e9-4e45-850b-b9888efd6521/revision/master/head/idMap.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success (federation):", + "content": "{\n mainTree: {\n idMap: {\n 261bf9df-64d7-4642-8bb2-0a79abd370ec: \"d86573c9-beec-4f06-b194-18b6983a3d71\",\n 528c62e6-5cf8-4868-b5ff-733c128b4b4e: \"6047f788-8317-45ff-b692-29e03071ec63\",\n 7d5ce878-6ec9-4c11-a96d-12b68c9e9c7c: \"7d9eefe0-2b8a-4de3-9acb-c216c9b48c9f\",\n 95744e20-4b4d-4fc1-8ba7-1f31ebf772b6: \"d2c0e845-b392-429e-86bd-6c7453b78654\",\n 71634e9c-da2c-4ea7-bd04-44971d3fd8dc: \"6e40ecbc-bb2f-4504-8f00-80b12fb04443\",\n a70dd58c-c09e-4ed4-ac7e-914dbd145302: \"f1a14ded-6528-4937-b31d-ce4b3ca813d8\",\n d68cf5e7-4d0f-4702-8a92-c81b72928c54: \"d012d6ba-01d2-4460-921e-72539a1ac197\"\n }\n },\n subModels: [\n {\n account: \"teamSpace1\",\n model: \"b1fceab8-b0e9-4e45-850b-b9888efd6521\",\n idMap: {\n a82a3b7f-bcd9-4487-8f94-370fa1f2ea4e: \"57b0969f-6009-4e32-9153-2b17d3a3628b\",\n 33c36fee-622d-46a5-8be1-a1bd295aa7d1: \"1e47d53e-cad8-489b-89ea-7c6c7b8d0e6c\"\n }\n },\n {\n account: \"teamSpace1\",\n model: \"7cf61b4f-acdf-4295-b2d0-9b45f9f27418\",\n idMap: {\n 8a1f9cad-18d8-47ce-9cbd-08ba53858ced: \"60286d41-d897-4de6-a0ed-0929fa68be96\",\n ea37c2ed-39d4-4236-843c-332d52876c96: \"9c4be293-0d8f-4e37-b115-d2c752824bfe\"\n }\n },\n {\n account: \"teamSpace1\",\n model: \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\",\n idMap: {\n 8ef1c52e-8838-46dc-9825-efe46aa10041: \"a4a14ee6-aa44-4f36-96bd-f80dbabf8ead\",\n ecc25d63-87e0-4600-ae60-f38f766bc9e4: \"ffd49cfd-57fb-4c31-84f7-02b41352b54f\",\n 3abc5450-5db8-459b-80ea-cb9fca9ccedd: \"a6947de3-25f4-4c2c-a150-22f0ed9ce4dd\"\n }\n }\n ]\n}", + "type": "json" + }, + { + "title": "Success (model):", + "content": "{\n mainTree: {\n idMap: {\n a82a3b7f-bcd9-4487-8f94-370fa1f2ea4e: \"57b0969f-6009-4e32-9153-2b17d3a3628b\",\n 33c36fee-622d-46a5-8be1-a1bd295aa7d1: \"1e47d53e-cad8-489b-89ea-7c6c7b8d0e6c\"\n }\n },\n subModels: []\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/idToMeshes.json", + "title": "Get ID to meshes", + "name": "getIdToMeshes", + "group": "Model", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to get ID Meshes for.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/b1fceab8-b0e9-4e45-850b-b9888efd6521/revision/master/head/idToMeshes.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n mainTree: {\n a82a3b7f-bcd9-4487-8f94-370fa1f2ea4e: [\n \"a82a3b7f-bcd9-4487-8f94-370fa1f2ea4e\"\n ],\n 33c36fee-622d-46a5-8be1-a1bd295aa7d1: [\n \"a82a3b7f-bcd9-4487-8f94-370fa1f2ea4e\"\n ]\n },\n subModels: []\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/:uid.json.mpc", + "title": "Get JSON Mpc", + "name": "getJsonMpc", + "group": "Model", + "description": "

Get the unity bundle mpc json file. The path for this api is provided in the data retrieved by either one of the endpoints /:teamspace/:model/revision/master/head/unityAssets.json or /:teamspace/:model/revision/:rev/unityAssets.json

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

id of the model to get JSON Mpc for.

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "uid", + "description": "

id of the json.mpc file

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/92fc213b-1bab-49a4-b10e-f4368a52d500_unity.json.mpc HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n numberOfIDs: 1,\n maxGeoCount: 1,\n mapping: [\n {\n name: \"ce413e99-8469-4ed0-86e3-ff50bf4fed89\",\n sharedID: \"a876e59a-8cda-4d61-b438-c74ce7b8855d\",\n min: [\n -3515.19556,\n -5790.91504,\n 0\n ],\n max: [\n 0,\n 0,\n 3502.927\n ],\n usage: [\n \"92fc213b-1bab-49a4-b10e-f4368a52d500_0\"\n ]\n }\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/modelProperties.json", + "title": "Get model properties", + "name": "getModelProperties", + "group": "Model", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to get properties for.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/b1fceab8-b0e9-4e45-850b-b9888efd6521/revision/master/head/modelProperties.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n properties: {\n hiddenNodes: []\n },\n subModels: []\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model.json", + "title": "Get model settings", + "name": "getModelSetting", + "group": "Model", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "Object", + "optional": false, + "field": "model", + "description": "

The modelId to get settings for.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n _id: \"3549ddf6-885d-4977-87f1-eeac43a0e818\",\n timestamp: \"2019-05-13T16:54:44.000Z\",\n type: \"Structural\",\n desc: \"\",\n name: \"Lego Tree\",\n subModels: [],\n surveyPoints: [],\n properties: {\n unit: \"mm\"\n },\n permissions: [\n \"change_model_settings\",\n \"upload_files\",\n \"create_issue\",\n \"comment_issue\",\n \"view_issue\",\n \"view_model\",\n \"download_model\",\n \"edit_federation\",\n \"delete_federation\",\n \"delete_model\",\n \"manage_model_permission\"\n ],\n status: \"ok\",\n id: \"3549ddf6-885d-4977-87f1-eeac43a0e818\",\n model: \"3549ddf6-885d-4977-87f1-eeac43a0e818\",\n account: \"teamSpace1\",\n headRevisions: {\n }\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/fulltree.json", + "title": "Get tree", + "name": "getModelTree", + "group": "Model", + "description": "

Returns the full tree for the model

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/revision/master/head/fulltree.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n mainTree: {\n nodes: {\n account: \"teamSpace1\",\n project: \"3549ddf6-885d-4977-87f1-eeac43a0e818\",\n type: \"transformation\",\n name: \"RootNode\",\n path: \"73a41cea-4c6b-47ed-936b-3f5641aecb52\",\n _id: \"73a41cea-4c6b-47ed-936b-3f5641aecb52\",\n shared_id: \"4dd46b6f-099e-42cd-b045-6460200e7995\",\n children: [\n {\n account: \"teamSpace1\",\n project: \"3549ddf6-885d-4977-87f1-eeac43a0e818\",\n type: \"transformation\",\n name: \"Fouliiferous Tree H64_2\",\n path: \"73a41cea-4c6b-47ed-936b-3f5641aecb52__33fe7c13-17a4-43d6-af03-ceae6880322f\",\n _id: \"33fe7c13-17a4-43d6-af03-ceae6880322f\",\n shared_id: \"b69a8384-c29d-4954-9efa-4c7bc14f1d3d\",\n children: [\n {\n account: \"teamSpace1\",\n project: \"3549ddf6-885d-4977-87f1-eeac43a0e818\",\n type: \"mesh\",\n name: \"Fouliiferous Tree H64\",\n path: \"73a41cea-4c6b-47ed-936b-3f5641aecb52__33fe7c13-17a4-43d6-af03-ceae6880322f__ce413e99-8469-4ed0-86e3-ff50bf4fed89\",\n _id: \"ce413e99-8469-4ed0-86e3-ff50bf4fed89\",\n shared_id: \"a876e59a-8cda-4d61-b438-c74ce7b8855d\",\n toggleState: \"visible\"\n }\n ],\n toggleState: \"visible\"\n }\n ],\n toggleState: \"visible\"\n },\n idToName: {\n ce413e99-8469-4ed0-86e3-ff50bf4fed89: \"Fouliiferous Tree H64\",\n 33fe7c13-17a4-43d6-af03-ceae6880322f: \"Fouliiferous Tree H64_2\",\n 73a41cea-4c6b-47ed-936b-3f5641aecb52: \"RootNode\"\n }\n },\n subTrees: []\n}", + "type": "json" + } + ] + }, + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to use.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/model/permissions?models=[MODELS]", + "title": "Get multiple models permissions", + "name": "getMultipleModelsPermissions", + "group": "Model", + "description": "

Gets the permissions of a list of models

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace.

" + } + ], + "Query": [ + { + "group": "Query", + "type": "String[]", + "optional": false, + "field": "MODELS", + "description": "

An array of model ids.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/models/permissions?models=5ce7dd19-1252-4548-a9c9-4a5414f2e0c5,3549ddf6-885d-4977-87f1-eeac43a0e818 HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "[\n {\n model: \"3549ddf6-885d-4977-87f1-eeac43a0e818\",\n name: \"Lego Tree\",\n permissions: [\n {\n user: \"collaboratorTeamspace1Model1JobA\",\n permission: \"collaborator\"\n },\n {\n user: \"commenterTeamspace1Model1JobA\",\n permission: \"commenter\"\n },\n {\n user: \"projectshared\"\n },\n {\n user: \"fed\"\n },\n {\n user: \"teamSpace1\"\n },\n {\n user: \"unassignedTeamspace1UserJobA\"\n },\n {\n user: \"viewerTeamspace1Model1JobA\"\n },\n {\n user: \"viewerTeamspace1Model1JobB\"\n },\n {\n user: \"commenterTeamspace1Model1JobB\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobB\"\n },\n {\n user: \"adminTeamspace1JobA\"\n },\n {\n user: \"adminTeamspace1JobB\"\n },\n {\n user: \"weirdTeamspace\"\n }\n ],\n subModels: []\n },\n {\n model: \"5ce7dd19-1252-4548-a9c9-4a5414f2e0c5\",\n federate: {\n },\n name: \"Full Logo \",\n permissions: [\n {\n user: \"viewerTeamspace1Model1JobA\",\n permission: \"viewer\"\n },\n {\n user: \"commenterTeamspace1Model1JobA\",\n permission: \"viewer\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobA\",\n permission: \"commenter\"\n },\n {\n user: \"commenterTeamspace1Model1JobB\",\n permission: \"commenter\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobB\",\n permission: \"collaborator\"\n },\n {\n user: \"projectshared\",\n permission: \"collaborator\"\n },\n {\n user: \"fed\"\n },\n {\n user: \"teamSpace1\"\n },\n {\n user: \"unassignedTeamspace1UserJobA\"\n },\n {\n user: \"viewerTeamspace1Model1JobB\"\n },\n {\n user: \"adminTeamspace1JobA\"\n },\n {\n user: \"adminTeamspace1JobB\"\n },\n {\n user: \"weirdTeamspace\"\n }\n ],\n subModels: [\n {\n database: \"teamSpace1\",\n model: \"7cf61b4f-acdf-4295-b2d0-9b45f9f27418\"\n },\n {\n database: \"teamSpace1\",\n model: \"b1fceab8-b0e9-4e45-850b-b9888efd6521\"\n }\n ]\n }\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:rev/idMap.json", + "title": "Get tree path by revision", + "name": "getRevIdMap", + "group": "Model", + "description": "

Get tree path by revision. See more details here.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to ID map for.

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

Revision to use.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:rev/idToMeshes.json", + "title": "Get ID Meshes by revision", + "name": "getRevIdToMeshes", + "group": "Model", + "description": "

Get ID Meshes by revision. See more details here.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to use.

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

Revision to use.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:rev/modelProperties.json", + "title": "Get model properties by revision", + "name": "getRevModelProperties", + "group": "Model", + "description": "

Get model properties by revision. See more details here.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to use.

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

Revision to use.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:rev/fulltree.json", + "title": "Get tree by revision", + "name": "getRevModelTree", + "group": "Model", + "description": "

Get full tree by revision. See more details here.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to get Tree for.

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

Revision to use.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:rev/srcAssets.json", + "title": "Get revision's src assets", + "name": "getRevSrcAssets", + "group": "Model", + "description": "

Get the model's assets but of a particular revision

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model Id to get unity assets for.

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

The revision of the model to get src assets for

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /Repo3DDemo/01713310-2286-11eb-93c1-296aba26cc11/revision/4d48e3de-1c87-4fdf-87bf-d92c224eb3fe/srcAssets.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n \"models\": [\n {\n \"database\": \"Repo3DDemo\",\n \"model\": \"011382b0-2286-11eb-93c1-296aba26cc11\",\n \"assets\": [\n \"153cf665-2c84-4ff9-a9e2-ba495af8e6dc\",\n \"07c67b6c-4b02-435f-8639-ea88403c36f7\",\n \"2967230f-67fa-45dc-9686-161e45c7c8a2\"\n ],\n \"offset\": [\n 9.999999999999787,\n 0,\n -9.999999999999787\n ]\n },\n {\n \"database\": \"Repo3DDemo\",\n \"model\": \"01168ff0-2286-11eb-93c1-296aba26cc11\",\n \"assets\": [\n \"89d5580a-3224-4e50-bbab-89d855c320e0\"\n ],\n \"offset\": [\n 1610,\n 740,\n -2410\n ]\n },\n {\n \"database\": \"Repo3DDemo\",\n \"model\": \"01153060-2286-11eb-93c1-296aba26cc11\",\n \"assets\": [\n \"c14dbbee-a8fd-4ed8-8641-9e24737f8238\"\n ],\n \"offset\": [\n -688.095458984375,\n 6410.9140625,\n 683.460205078125\n ]\n }\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:rev/unityAssets.json", + "title": "Get revision's unity assets", + "name": "getRevUnityAssets", + "group": "Model", + "description": "

Get the model's assets but of a particular revision

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model Id to get unity assets for.

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

The revision of the model to get unity assets for

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/revision/master/head/unityAssets.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n models: [\n {\n _id: \"Mw+Qm5J5QaqofBxG9TqOkw==\",\n assets: [\n \"/teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/92fc213b-1bab-49a4-b10e-f4368a52d500.unity3d\"\n ],\n database: \"teamSpace1\",\n model: \"3549ddf6-885d-4977-87f1-eeac43a0e818\",\n offset: [\n -688.095458984375,\n 6410.9140625,\n 683.460205078125\n ],\n jsonFiles: [\n \"/teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/92fc213b-1bab-49a4-b10e-f4368a52d500_unity.json.mpc\"\n ]\n }\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:rev/assetsMeta", + "title": "Get revision's metadata about the assets generated", + "name": "getRevUnityAssets", + "group": "Model", + "description": "

Get the model's assets metadata of a particular revision

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model Id

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

The revision of the model

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/revision/master/head/assetsMeta HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n superMeshes: [\n {\n _id: \"\",\n nVertices: 123,\n nFaces: 123,\n nUVChannels: 123,\n boundingBox: [[1, 2, 3], [3,4, 5]]\n },\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/:uid.src.mpc", + "title": "Get Model in SRC representation", + "name": "getSRC", + "group": "Model", + "description": "

Get a mesh presented in SRC format.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

id of the model

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "uid", + "description": "

id of the SRC file.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/permissions", + "title": "Get model permissions", + "name": "getSingleModelPermissions", + "group": "Model", + "description": "

Gets the permissions of a model

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to get Permission for.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/permissions HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "[\n {\n user: \"viewerTeamspace1Model1JobA\",\n permission: \"viewer\"\n },\n {\n user: \"commenterTeamspace1Model1JobA\",\n permission: \"viewer\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobA\",\n permission: \"commenter\"\n },\n {\n user: \"commenterTeamspace1Model1JobB\",\n permission: \"commenter\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobB\",\n permission: \"collaborator\"\n },\n {\n user: \"projectshared\",\n permission: \"collaborator\"\n },\n {\n user: \"fed\"\n },\n {\n user: \"teamSpace1\"\n },\n {\n user: \"unassignedTeamspace1UserJobA\"\n },\n {\n user: \"viewerTeamspace1Model1JobB\"\n },\n {\n user: \"adminTeamspace1JobA\"\n },\n {\n user: \"adminTeamspace1JobB\"\n },\n {\n user: \"weirdTeamspace\"\n }\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/srcAssets.json", + "title": "Get Src assets for the master branch", + "name": "getSrcAssets", + "group": "Model", + "description": "

Get the lastest model's version src assets

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model Id to get unity assets for.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /Repo3DDemo/01713310-2286-11eb-93c1-296aba26cc11/revision/master/head/srcAssets.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n \"models\": [\n {\n \"database\": \"Repo3DDemo\",\n \"model\": \"011382b0-2286-11eb-93c1-296aba26cc11\",\n \"assets\": [\n \"153cf665-2c84-4ff9-a9e2-ba495af8e6dc\",\n \"07c67b6c-4b02-435f-8639-ea88403c36f7\",\n \"2967230f-67fa-45dc-9686-161e45c7c8a2\"\n ],\n \"offset\": [\n 9.999999999999787,\n 0,\n -9.999999999999787\n ]\n },\n {\n \"database\": \"Repo3DDemo\",\n \"model\": \"01168ff0-2286-11eb-93c1-296aba26cc11\",\n \"assets\": [\n \"89d5580a-3224-4e50-bbab-89d855c320e0\"\n ],\n \"offset\": [\n 1610,\n 740,\n -2410\n ]\n },\n {\n \"database\": \"Repo3DDemo\",\n \"model\": \"01153060-2286-11eb-93c1-296aba26cc11\",\n \"assets\": [\n \"c14dbbee-a8fd-4ed8-8641-9e24737f8238\"\n ],\n \"offset\": [\n -688.095458984375,\n 6410.9140625,\n 683.460205078125\n ]\n }\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:revId/subModelRevisions", + "title": "Get submodel revisions by rev", + "name": "getSubModelRevisionsByRev", + "group": "Model", + "description": "

In a federation it returns the submodels revisions of a particular federation revision. See more details here

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to get properties for.

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

Revision to use.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/subModelRevisions", + "title": "Get submodels revisions", + "name": "getSubRevisionModels", + "group": "Model", + "description": "

In a federation it returns the submodels revisions of the latest federation revision.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to get properties for.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/5ce7dd19-1252-4548-a9c9-4a5414f2e0c5/revision/master/head/subModelRevisions HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n \"b1fceab8-b0e9-4e45-850b-b9888efd6521\": {\n \"name\": \"block\",\n \"revisions\": [\n {\n \"_id\": \"ddcc3213-af61-4d30-921f-e502d1c2199c\",\n \"author\": \"teamSpace1\",\n \"tag\": \"block\",\n \"timestamp\": \"2019-05-02T16:16:49.000Z\",\n \"name\": \"ddcc3213-af61-4d30-921f-e502d1c2199c\",\n \"branch\": \"master\"\n }\n ]\n },\n \"7cf61b4f-acdf-4295-b2d0-9b45f9f27418\": {\n \"name\": \"letters\",\n \"revisions\": [\n {\n \"_id\": \"a1bcfa72-ff37-41ac-95ab-66e450a37896\",\n \"author\": \"teamSpace1\",\n \"tag\": \"letters\",\n \"timestamp\": \"2019-05-02T16:16:32.000Z\",\n \"name\": \"a1bcfa72-ff37-41ac-95ab-66e450a37896\",\n \"branch\": \"master\"\n }\n ]\n },\n \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\": {\n \"name\": \"pipes\",\n \"revisions\": [\n {\n \"_id\": \"9ee1190b-cd25-4467-8d38-5af7c77cab5a\",\n \"author\": \"teamSpace1\",\n \"tag\": \"pipes\",\n \"timestamp\": \"2019-05-02T16:17:04.000Z\",\n \"name\": \"9ee1190b-cd25-4467-8d38-5af7c77cab5a\",\n \"branch\": \"master\"\n }\n ]\n }\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/tree_path.json", + "title": "Get tree paths", + "name": "getTreePath", + "group": "Model", + "description": "

Returns the full tree path for the model and if the model is a federation of it submodels. These tree paths have the path to get to every object in the model.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to get tree path for.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/5ce7dd19-1252-4548-a9c9-4a5414f2e0c5/revision/master/head/tree_path.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n mainTree: {\n idToPath: {\n d68cf5e7-4d0f-4702-8a92-c81b72928c54: \"d68cf5e7-4d0f-4702-8a92-c81b72928c54\",\n 261bf9df-64d7-4642-8bb2-0a79abd370ec: \"d68cf5e7-4d0f-4702-8a92-c81b72928c54__528c62e6-5cf8-4868-b5ff-733c128b4b4e__261bf9df-64d7-4642-8bb2-0a79abd370ec\",\n 528c62e6-5cf8-4868-b5ff-733c128b4b4e: \"d68cf5e7-4d0f-4702-8a92-c81b72928c54__528c62e6-5cf8-4868-b5ff-733c128b4b4e\",\n 7d5ce878-6ec9-4c11-a96d-12b68c9e9c7c: \"d68cf5e7-4d0f-4702-8a92-c81b72928c54__95744e20-4b4d-4fc1-8ba7-1f31ebf772b6__7d5ce878-6ec9-4c11-a96d-12b68c9e9c7c\",\n 71634e9c-da2c-4ea7-bd04-44971d3fd8dc: \"d68cf5e7-4d0f-4702-8a92-c81b72928c54__a70dd58c-c09e-4ed4-ac7e-914dbd145302__71634e9c-da2c-4ea7-bd04-44971d3fd8dc\",\n 95744e20-4b4d-4fc1-8ba7-1f31ebf772b6: \"d68cf5e7-4d0f-4702-8a92-c81b72928c54__95744e20-4b4d-4fc1-8ba7-1f31ebf772b6\",\n a70dd58c-c09e-4ed4-ac7e-914dbd145302: \"d68cf5e7-4d0f-4702-8a92-c81b72928c54__a70dd58c-c09e-4ed4-ac7e-914dbd145302\"\n }\n },\n subModels: [\n {\n account: \"teamSpace1\",\n model: \"b1fceab8-b0e9-4e45-850b-b9888efd6521\",\n idToPath: {\n a82a3b7f-bcd9-4487-8f94-370fa1f2ea4e: \"33c36fee-622d-46a5-8be1-a1bd295aa7d1__a82a3b7f-bcd9-4487-8f94-370fa1f2ea4e\",\n 33c36fee-622d-46a5-8be1-a1bd295aa7d1: \"33c36fee-622d-46a5-8be1-a1bd295aa7d1\"\n }\n },\n {\n account: \"teamSpace1\",\n model: \"7cf61b4f-acdf-4295-b2d0-9b45f9f27418\",\n idToPath: {\n 8a1f9cad-18d8-47ce-9cbd-08ba53858ced: \"ea37c2ed-39d4-4236-843c-332d52876c96__8a1f9cad-18d8-47ce-9cbd-08ba53858ced\",\n ea37c2ed-39d4-4236-843c-332d52876c96: \"ea37c2ed-39d4-4236-843c-332d52876c96\"\n }\n },\n {\n account: \"teamSpace1\",\n model: \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\",\n idToPath: {\n 8ef1c52e-8838-46dc-9825-efe46aa10041: \"3abc5450-5db8-459b-80ea-cb9fca9ccedd__8ef1c52e-8838-46dc-9825-efe46aa10041\",\n ecc25d63-87e0-4600-ae60-f38f766bc9e4: \"3abc5450-5db8-459b-80ea-cb9fca9ccedd__ecc25d63-87e0-4600-ae60-f38f766bc9e4\",\n 3abc5450-5db8-459b-80ea-cb9fca9ccedd: \"3abc5450-5db8-459b-80ea-cb9fca9ccedd\"\n }\n }\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:rev/tree_path.json", + "title": "Get tree path by revision", + "name": "getTreePathByRevision", + "group": "Model", + "description": "

Get tree path by revision. See more details here.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to get tree path for.

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

Revision to use.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/unityAssets.json", + "title": "Get unity assets", + "name": "getUnityAssets", + "group": "Model", + "description": "

Get the lastest model's version unity assets

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model Id to get unity assets for.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/revision/master/head/unityAssets.json HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n models: [\n {\n _id: \"Mw+Qm5J5QaqofBxG9TqOkw==\",\n assets: [\n \"/teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/92fc213b-1bab-49a4-b10e-f4368a52d500.unity3d\"\n ],\n database: \"teamSpace1\",\n model: \"3549ddf6-885d-4977-87f1-eeac43a0e818\",\n offset: [\n -688.095458984375,\n 6410.9140625,\n 683.460205078125\n ],\n jsonFiles: [\n \"/teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/92fc213b-1bab-49a4-b10e-f4368a52d500_unity.json.mpc\"\n ]\n }\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/unityAssets.json", + "title": "Get unity assets", + "name": "getUnityAssets", + "group": "Model", + "description": "

Get the lastest model's version unity assets

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model Id to get unity assets for.

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

The revision of the model

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/revision/master/head/unityAssets.json HTTP/1.1", + "type": "get" + }, + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/revision/master/head/assetsMeta HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n superMeshes: [\n {\n _id: \"\",\n nVertices: 123,\n nFaces: 123,\n nUVChannels: 123,\n boundingBox: [[1, 2, 3], [3,4, 5]]\n },\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/:uid.unity3d", + "title": "Get Unity Bundle", + "name": "getUnityBundle", + "group": "Model", + "description": "

Gets an actual unity bundle file. The path for this api is provided in the data retrieved by either one of the endpoints /:teamspace/:model/revision/master/head/unityAssets.json or /:teamspace/:model/revision/:rev/unityAssets.json

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

id of the model

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "uid", + "description": "

id of the unity bundle

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "post", + "url": "/:teamspace/:model/upload/ms-chunking", + "title": "Initialise MS chunking request", + "name": "initChunking", + "group": "Model", + "description": "

Initiate model revision data for MS Logic Apps chunked upload.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model id to upload.

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "filename", + "description": "

Filename of content to upload

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "tag", + "description": "

Tag name for new revision

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "desc", + "description": "

Description for new revision

" + }, + { + "group": "Request body", + "type": "Boolean", + "optional": true, + "field": "importAnimations", + "description": "

Whether to import animations within a sequence

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /teamSpace1/b1fceab8-b0e9-4e45-850b-b9888efd6521/upload/ms-chunking HTTP/1.1\n{\n\t\"filename\": \"structure.ifc\",\n\t\"tag\": \"rev001\",\n\t\"desc\": \"Revision 2\"\n}", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response:", + "content": "HTTP/1.1 200 OK\n{\n\t\"corID\": \"00000000-0000-1111-2222-333333333333\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/master/head/searchtree.json?searchString=[searchString]", + "title": "Search model tree", + "name": "searchModelTree", + "group": "Model", + "description": "

Searches the model (or models if it is a federation) tree and returns the objects matching their names with the searchString param.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to use.

" + } + ], + "Query": [ + { + "group": "Query", + "type": "String", + "optional": false, + "field": "searchString", + "description": "

The string to use for search tree objects

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/revision/master/head/searchtree.json?searchString=fou HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "[\n {\n \"_id\": \"33fe7c13-17a4-43d6-af03-ceae6880322f\",\n \"name\": \"Fouliiferous Tree H64_2\",\n \"account\": \"teamSpace1\",\n \"model\": \"3549ddf6-885d-4977-87f1-eeac43a0e818\"\n },\n {\n \"_id\": \"ce413e99-8469-4ed0-86e3-ff50bf4fed89\",\n \"name\": \"Fouliiferous Tree H64\",\n \"account\": \"teamSpace1\",\n \"model\": \"3549ddf6-885d-4977-87f1-eeac43a0e818\"\n }\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "get", + "url": "/:teamspace/:model/revision/:rev/searchtree.json?searchString=[searchString]", + "title": "Search model tree by revision", + "name": "searchModelTreeRev", + "group": "Model", + "description": "

Searches the model (or models if it is a federation) tree and returns the objects matching their names with the searchString param. See more details here

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to use.

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "rev", + "description": "

Revision to use.

" + } + ], + "Query": [ + { + "group": "Query", + "type": "String", + "optional": false, + "field": "searchString", + "description": "

The string to use for search tree objects

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "put", + "url": "/:teamspace/:model/settings/heliSpeed", + "title": "Update model heli speed", + "name": "updateHeliSpeed", + "group": "Model", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to Update Heli speed.

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "Number", + "optional": false, + "field": "heliSpeed", + "description": "

The value of the speed that will replace the heli speed.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "PUT /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/settings/heliSpeed HTTP/1.1\n{\"heliSpeed\":3}", + "type": "put" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "put", + "url": "/:teamspace/:model", + "title": "Update Federated Model", + "name": "updateModel", + "group": "Model", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Federated Model ID to update

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "[]Submodel", + "optional": false, + "field": "subModels", + "description": "

Information on the models that are going to get federated

" + } + ], + "Request body: SubModel": [ + { + "group": "Request body: SubModel", + "type": "String", + "optional": false, + "field": "database", + "description": "

The teamspace name which the model belongs to

" + }, + { + "group": "Request body: SubModel", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model id to be federated

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "PUT /teamSpace1/5ce7dd19-1252-4548-a9c9-4a5414f2e0c5 HTTP/1.1\n{\n subModels: [\n {\n database: \"teamSpace1\",\n model: \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\",\n },\n {\n database: \"teamSpace1\",\n model: \"7cf61b4f-acdf-4295-b2d0-9b45f9f27418\",\n }\n ]\n}", + "type": "put" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n account: \"teamSpace1\",\n model: \"5ce7dd19-1252-4548-a9c9-4a5414f2e0c5\",\n setting: {\n _id: \"5ce7dd19-1252-4548-a9c9-4a5414f2e0c5\",\n federate: {\n },\n desc: \"\",\n name: \"Full Logo test\",\n timestamp: \"2019-08-22T10:42:05.242Z\",\n type: \"Federation\",\n subModels: [\n {\n database: \"teamSpace1\",\n model: \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\"\n },\n {\n database: \"teamSpace1\",\n model: \"7cf61b4f-acdf-4295-b2d0-9b45f9f27418\"\n }\n ],\n surveyPoints: [\n {\n position: [\n 0,\n 0,\n 0\n ],\n latLong: [\n 0,\n 0\n ]\n }\n ],\n properties: {\n unit: \"mm\"\n },\n permissions: [\n {\n user: \"viewerTeamspace1Model1JobA\",\n permission: \"viewer\"\n },\n {\n user: \"commenterTeamspace1Model1JobA\",\n permission: \"commenter\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobA\",\n permission: \"collaborator\"\n },\n {\n user: \"commenterTeamspace1Model1JobB\",\n permission: \"commenter\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobB\",\n permission: \"collaborator\"\n }\n ],\n status: \"ok\"\n }\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "patch", + "url": "/:teamspace/:model/permissions", + "title": "Update model permissions", + "name": "updateModelPermissions", + "group": "Model", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "Permission[]", + "optional": false, + "field": "BODY", + "description": "

List of user permissions

" + } + ], + "Request body: Permission": [ + { + "group": "Request body: Permission", + "type": "string", + "optional": false, + "field": "user", + "description": "

User ID

" + }, + { + "group": "Request body: Permission", + "type": "string", + "optional": false, + "field": "permission", + "description": "

Permission type ('viewer'|'commenter'|'collaborator'|'').

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage (add user permission):", + "content": "PATCH /acme/00000000-0000-0000-0000-000000000000/permissions HTTP/1.1\n[\n {\n user: \"alice\",\n permission: \"collaborator\"\n }\n]", + "type": "patch" + }, + { + "title": "Example usage (add multiple user permissions):", + "content": "PATCH /acme/00000000-0000-0000-0000-000000000000/permissions HTTP/1.1\n[\n {\n user: \"bob\",\n permission: \"commenter\"\n },\n {\n user: \"mike\",\n permission: \"viewer\"\n }\n]", + "type": "patch" + }, + { + "title": "Example usage (remove user permission):", + "content": "PATCH /acme/00000000-0000-0000-0000-000000000000/permissions HTTP/1.1\n[\n {\n user: \"mike\",\n permission: \"\"\n }\n]", + "type": "patch" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n status: \"ok\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "post", + "url": "/:teamspace/models/permissions", + "title": "Update multiple models permissions", + "name": "updateMultiplePermissions", + "group": "Model", + "deprecated": { + "content": "use now (#Model:batchUpdateModelPermissions)" + }, + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace.

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "[]ModelPermissions", + "optional": false, + "field": "BODY", + "description": "

Its an array with a list of model ids and their permissions.

" + } + ], + "Request body: ModelPermissions": [ + { + "group": "Request body: ModelPermissions", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model id of the model that will have their permission changed. If it's a federation the entry in the response corresponding with the model will have the 'federated' field set to true.

" + }, + { + "group": "Request body: ModelPermissions", + "type": "[]Permission", + "optional": false, + "field": "permissions", + "description": "

An array indicating the new permissions.

" + } + ], + "Request body: Permission": [ + { + "group": "Request body: Permission", + "type": "string", + "optional": false, + "field": "user", + "description": "

User ID

" + }, + { + "group": "Request body: Permission", + "type": "string", + "optional": false, + "field": "permission", + "description": "

Permission type ('viewer'|'commenter'|'collaborator'|'').

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /teamSpace1/models/permissions HTTP/1.1\n[\n {\n model: \"5ce7dd19-1252-4548-a9c9-4a5414f2e0c5\",\n permissions: [\n {\n user: \"viewerTeamspace1Model1JobA\",\n permission: \"viewer\"\n },\n {\n user: \"commenterTeamspace1Model1JobA\",\n permission: \"viewer\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobA\",\n permission: \"collaborator\"\n },\n {\n user: \"commenterTeamspace1Model1JobB\",\n permission: \"commenter\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobB\",\n permission: \"collaborator\"\n }\n ]\n }\n]", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "[\n {\n name: \"Full Logo \",\n federate: true,\n model: \"5ce7dd19-1252-4548-a9c9-4a5414f2e0c5\",\n permissions: [\n {\n user: \"viewerTeamspace1Model1JobA\",\n permission: \"viewer\"\n },\n {\n user: \"commenterTeamspace1Model1JobA\",\n permission: \"viewer\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobA\",\n permission: \"collaborator\"\n },\n {\n user: \"commenterTeamspace1Model1JobB\",\n permission: \"commenter\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobB\",\n permission: \"collaborator\"\n },\n {\n user: \"projectshared\"\n },\n {\n user: \"fed\"\n },\n {\n user: \"teamSpace1\"\n },\n {\n user: \"unassignedTeamspace1UserJobA\"\n },\n {\n user: \"viewerTeamspace1Model1JobB\"\n },\n {\n user: \"adminTeamspace1JobA\"\n },\n {\n user: \"adminTeamspace1JobB\"\n },\n {\n user: \"weirdTeamspace\"\n }\n ],\n subModels: [\n {\n database: \"teamSpace1\",\n model: \"7cf61b4f-acdf-4295-b2d0-9b45f9f27418\"\n },\n {\n database: \"teamSpace1\",\n model: \"b1fceab8-b0e9-4e45-850b-b9888efd6521\"\n }\n ]\n }\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "post", + "url": "/:teamspace/:model/permissions", + "title": "Update model permissions", + "name": "updatePermissions", + "group": "Model", + "deprecated": { + "content": "use now (#Model:updateModelPermissions)" + }, + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model id of the model to be updated

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "[]Permissions", + "optional": false, + "field": "BODY", + "description": "

Its an array with a list of users and their permission type.

" + } + ], + "Request body: Permission": [ + { + "group": "Request body: Permission", + "type": "string", + "optional": false, + "field": "user", + "description": "

User ID

" + }, + { + "group": "Request body: Permission", + "type": "string", + "optional": false, + "field": "permission", + "description": "

Permission type ('viewer'|'commenter'|'collaborator'|'').

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /teamSpace1/5ce7dd19-1252-4548-a9c9-4a5414f2e0c5/permissions HTTP/1.1\n[\n {\n user: \"viewerTeamspace1Model1JobA\",\n permission: \"collaborator\"\n },\n {\n user: \"commenterTeamspace1Model1JobA\",\n permission: \"viewer\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobA\",\n permission: \"collaborator\"\n },\n {\n user: \"commenterTeamspace1Model1JobB\",\n permission: \"commenter\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobB\",\n permission: \"collaborator\"\n }\n]", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n _id: \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\",\n timestamp: \"2019-05-02T16:17:14.000Z\",\n type: \"Architectural\",\n desc: \"\",\n name: \"pipes\",\n subModels: [],\n surveyPoints: [\n {\n position: [\n 0,\n 0,\n 0\n ],\n latLong: [\n 0,\n 0\n ]\n }\n ],\n properties: {\n unit: \"mm\"\n },\n permissions: [\n {\n user: \"viewerTeamspace1Model1JobA\",\n permission: \"collaborator\"\n },\n {\n user: \"commenterTeamspace1Model1JobA\",\n permission: \"viewer\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobA\",\n permission: \"collaborator\"\n },\n {\n user: \"commenterTeamspace1Model1JobB\",\n permission: \"commenter\"\n },\n {\n user: \"collaboratorTeamspace1Model1JobB\",\n permission: \"collaborator\"\n }\n ],\n status: \"ok\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "put", + "url": "/:teamspace/:model/settings/", + "title": "Update Model Settings", + "name": "updateSettings", + "group": "Model", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model to update Settings.

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "name", + "description": "

Name of the model to be created

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "unit", + "description": "

The unit in which the model is specified

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "code", + "description": "

A code to be associated with the model; it can be of maximum 5 letters (a-z) and numbers

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "type", + "description": "

The type of the model

" + }, + { + "group": "Request body", + "type": "Number", + "optional": false, + "field": "angleFromNorth", + "description": "

GIS bearing angle

" + }, + { + "group": "Request body", + "type": "Number", + "optional": false, + "field": "elevation", + "description": "

GIS elevation

" + }, + { + "group": "Request body", + "type": "[]SurveyPoint", + "optional": false, + "field": "surveyPoints", + "description": "

an array containing GIS surveypoints

" + } + ], + "Request body: SurveyPoint": [ + { + "group": "Request body: SurveyPoint", + "type": "Number[]", + "optional": false, + "field": "position", + "description": "

an array representing a three dimensional coordinate

" + }, + { + "group": "Request body: SurveyPoint", + "type": "Number[]", + "optional": false, + "field": "latLong", + "description": "

an array representing a two dimensional coordinate for latitude and logitude

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "PUT /teamSpace1/3549ddf6-885d-4977-87f1-eeac43a0e818/settings HTTP/1.1\n{\n name: \"Medieval\",\n unit: \"cm\",\n code: \"1233\",\n type: \"Architectural\",\n angleFromNorth: 3,\n elevation: 0,\n surveyPoints: [\n {\n position: [\n 4,\n -7,\n -1\n ],\n latLong: [\n 1,\n 2,\n ]\n }\n ]\n}", + "type": "put" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n code: \"stage\",\n unit: \"cm\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "patch", + "url": "/:teamspace/:model/upload/ms-chunking/:corID", + "title": "Upload model chunk", + "name": "uploadChunk", + "group": "Model", + "description": "

Upload model chunk for Microsoft Logic Apps.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID to upload

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "corID", + "description": "

Upload correlation ID

" + } + ], + "Request header": [ + { + "group": "Request header", + "type": "String", + "optional": false, + "field": "Content-Range", + "description": "

Byte range for the current content chunk, including the starting value, ending value, and the total content size, for example: "bytes 0-1023/10100"

" + }, + { + "group": "Request header", + "type": "String", + "optional": false, + "field": "Content-Type", + "description": "

Type of chunked content

" + }, + { + "group": "Request header", + "type": "String", + "optional": false, + "field": "Content-Length", + "description": "

Length of size in bytes of the current chunk

" + } + ], + "Request body: Attachment": [ + { + "group": "Request body: Attachment", + "type": "binary", + "optional": false, + "field": "FILE", + "description": "

the file to be uploaded

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "String", + "optional": false, + "field": "Range", + "description": "

Byte range for content that has been received by the endpoint, for example: "bytes=0-1023"

" + }, + { + "group": "200", + "type": "Number", + "optional": true, + "field": "x-ms-chunk-size", + "description": "

Suggested chunk size in bytes

" + } + ] + }, + "examples": [ + { + "title": "Success-Response:", + "content": "HTTP/1.1 200 OK\n{\n\t\"Range\": \"bytes=0-1023\",\n\t\"x-ms-chunk-size\": 1024\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "PATCH /teamSpace1/b1fceab8-b0e9-4e45-850b-b9888efd6521/upload/ms-chunking/00000000-0000-1111-2222-333333333333 HTTP/1.1\n\nheader: {\n\t\"Content-Range\": \"bytes 0-1023/10100\",\n\t\"Content-Type\": \"application/octet-stream\",\n\t\"Content-Length\": \"bytes=1024\"\n}\n\nbody: {\n\t\"file\": \n}", + "type": "patch" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "post", + "url": "/:teamspace/:model/upload/ms-chunking/:corID", + "title": "Start MS chunking upload", + "name": "uploadChunksStart", + "group": "Model", + "description": "

Start chunked model upload for Microsoft Logic Apps. Max chunk size defined as 52,428,800 bytes (52 MB) based on https://docs.microsoft.com/en-us/azure/logic-apps/logic-apps-limits-and-config?tabs=azure-portal

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID to upload

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "corID", + "description": "

Upload correlation ID

" + } + ], + "Request header": [ + { + "group": "Request header", + "type": "String", + "optional": false, + "field": "x-ms-transfer-mode", + "description": "

Indicates that the content is uploaded in chunks; value="chunked"

" + }, + { + "group": "Request header", + "type": "Number", + "optional": false, + "field": "x-ms-content-length", + "description": "

The entire content size in bytes before chunking

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "Number", + "optional": true, + "field": "x-ms-chunk-size", + "description": "

Suggested chunk size in bytes

" + }, + { + "group": "200", + "type": "String", + "optional": false, + "field": "Location", + "description": "

The URL location where to send the HTTP PATCH messages

" + } + ] + }, + "examples": [ + { + "title": "Success-Response:", + "content": "HTTP/1.1 200 OK\n{\n\t\"x-ms-chunk-size\": 1024,\n\t\"Location\": \"/teamSpace1/b1fceab8-b0e9-4e45-850b-b9888efd6521/upload/ms-chunking/00000000-0000-1111-2222-333333333333\"\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /teamSpace1/b1fceab8-b0e9-4e45-850b-b9888efd6521/upload/ms-chunking/00000000-0000-1111-2222-333333333333 HTTP/1.1\n\nheader: {\n\t\"x-ms-transfer-mode\": \"chunked\",\n\t\"x-ms-content-length\": 10100\n}", + "type": "post" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "post", + "url": "/:teamspace/:model/upload", + "title": "Upload Model.", + "name": "uploadModel", + "group": "Model", + "description": "

It uploads a model file and creates a new revision for that model.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model id to upload.

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "tag", + "description": "

the tag name for the new revision

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "desc", + "description": "

the description for the new revision

" + }, + { + "group": "Request body", + "type": "Boolean", + "optional": true, + "field": "importAnimations", + "description": "

whether to import animations within a sequence

" + } + ], + "Request body: Attachment": [ + { + "group": "Request body: Attachment", + "type": "binary", + "optional": false, + "field": "FILE", + "description": "

the file to be uploaded

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /teamSpace1/b1fceab8-b0e9-4e45-850b-b9888efd6521/upload HTTP/1.1\nContent-Type: multipart/form-data; boundary=----WebKitFormBoundarySos0xligf1T8Sy8I\n\n------WebKitFormBoundarySos0xligf1T8Sy8I\nContent-Disposition: form-data; name=\"file\"; filename=\"3DrepoBIM.obj\"\nContent-Type: application/octet-stream\n\n\n------WebKitFormBoundarySos0xligf1T8Sy8I\nContent-Disposition: form-data; name=\"tag\"\n\nrev1\n------WebKitFormBoundarySos0xligf1T8Sy8I\nContent-Disposition: form-data; name=\"desc\"\n\nel paso\n------WebKitFormBoundarySos0xligf1T8Sy8I-- *", + "type": "post" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/model.js", + "groupTitle": "Model" + }, + { + "type": "delete", + "url": "/notifications", + "title": "Delete All notification", + "name": "deleteAllNotifications", + "group": "Notification", + "version": "0.0.0", + "filename": "src/v4/routes/notification.js", + "groupTitle": "Notification" + }, + { + "type": "delete", + "url": "/notifications/:id", + "title": "Delete a notification", + "name": "deleteNotification", + "group": "Notification", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "optional": false, + "field": "id", + "description": "

Unique Notification ID

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/notification.js", + "groupTitle": "Notification" + }, + { + "type": "get", + "url": "/notifications/:id", + "title": "Get a notification", + "name": "getNotification", + "group": "Notification", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "id", + "description": "

Unique Notification ID

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/notification.js", + "groupTitle": "Notification" + }, + { + "type": "get", + "url": "/notifications", + "title": "Get all notifications", + "name": "getNotifications", + "group": "Notification", + "version": "0.0.0", + "filename": "src/v4/routes/notification.js", + "groupTitle": "Notification" + }, + { + "type": "patch", + "url": "/notifications/:id", + "title": "Patch a notification", + "name": "patchNotification", + "group": "Notification", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "id", + "description": "

Unique Notification ID

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/notification.js", + "groupTitle": "Notification" + }, + { + "type": "patch", + "url": "/notifications", + "title": "Patch all the user notifications", + "name": "patchNotification", + "group": "Notification", + "version": "0.0.0", + "filename": "src/v4/routes/notification.js", + "groupTitle": "Notification" + }, + { + "type": "get", + "url": "/:teamspace/:model/permission-templates", + "title": "List all model templates", + "name": "listModelTemplates", + "group": "PermissionTemplate", + "description": "

Get a list of model permission templates. Intended for users that have manage_model_permission privileges.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/permission-templates HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/permissionTemplate.js", + "groupTitle": "Permission Template", + "groupDescription": "

Permission template is a grouping of model level permissions. An ID is assigned to it as well. They are viewer, commenter, and collaborator.

Three default permission templates are created by default. They are viewer, commenter, and collaborator.

", + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"_id\":\"Template1\",\n\t\t\"permissions\":[\n\t\t\t\"view_model\"\n\t\t]\n\t},\n\t{\n\t\t\"_id\":\"Template2\",\n\t\t\"permissions\":[\n\t\t\t\"view_model\",\n\t\t\t\"view_issue\"\n\t\t]\n\t}\n]", + "type": "json" + } + ] + } + }, + { + "type": "get", + "url": "/:teamspace/permission-templates", + "title": "Get all templates", + "name": "listTemplates", + "group": "PermissionTemplate", + "description": "

Get a list of teamspace permission templates.

", + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/permission-templates HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/permissionTemplate.js", + "groupTitle": "Permission Template", + "groupDescription": "

Permission template is a grouping of model level permissions. An ID is assigned to it as well. They are viewer, commenter, and collaborator.

Three default permission templates are created by default. They are viewer, commenter, and collaborator.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"_id\":\"Template1\",\n\t\t\"permissions\":[\n\t\t\t\"view_model\"\n\t\t]\n\t},\n\t{\n\t\t\"_id\":\"Template2\",\n\t\t\"permissions\":[\n\t\t\t\"view_model\",\n\t\t\t\"view_issue\"\n\t\t]\n\t}\n]", + "type": "json" + } + ] + } + }, + { + "type": "get", + "url": "/plans", + "title": "List all Plans", + "name": "listPlans", + "group": "Plan", + "version": "0.0.0", + "filename": "src/v4/routes/plan.js", + "groupTitle": "Plan" + }, + { + "type": "put", + "url": "/:teamspace/:model/presentation/:code/start", + "title": "Starts a presentation session and returns the presentation code", + "name": "startPresentation", + "group": "Presentation", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

The teamspace where the presentation is taking place

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model where the presentation is taking place

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /teamSpace1/5ce7dd19-1252-4548-a9c9-4a5414f2e0c5/presentation/start HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{ code: \"aASnk\" }", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/presentation.js", + "groupTitle": "Presentation" + }, + { + "type": "put", + "url": "/:teamspace/:model/presentation/:code/start", + "title": "Starts a presentation session and returns the presentation code", + "name": "startPresentation", + "group": "Presentation", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

The teamspace where the presentation is taking place

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model where the presentation is taking place

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "code", + "description": "

The code that users need to join in order to get the viewpoint.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /teamSpace1/5ce7dd19-1252-4548-a9c9-4a5414f2e0c5/presentation/start HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{ code: \"aASnk\" }", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/presentation.js", + "groupTitle": "Presentation" + }, + { + "type": "put", + "url": "/:teamspace/:model/presentation/:code/stream", + "title": "Streams a viewpoint", + "name": "streamPresentation", + "group": "Presentation", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

The teamspace where the presentation is taking place

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model where the presentation is taking place

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "code", + "description": "

The code that users need to join in order to get the viewpoint.

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "StreamingViewpoint", + "optional": false, + "field": "The", + "description": "

viewpoint

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/presentation.js", + "groupTitle": "Presentation" + }, + { + "type": "post", + "url": "/:teamspace/projects", + "title": "Create project", + "name": "createProject", + "group": "Project", + "description": "

It creates a project. The name of the project is required.

", + "permission": [ + { + "name": "canCreateProject" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of the teamspace

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "name", + "description": "

The name of the project to be created

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /teamSpace1/projects HTTP/1.1\n{name: \"Classic project\"}", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success", + "content": "{\n name: \"Classic project\",\n _id: \"5d5bec491c15383184eb7521\",\n permissions: [\n \"create_model\",\n \"create_federation\",\n \"admin_project\",\n \"edit_project\",\n \"delete_project\",\n \"upload_files_all_models\",\n \"edit_federation_all_models\",\n \"create_issue_all_models\",\n \"comment_issue_all_models\",\n \"view_issue_all_models\",\n \"view_model_all_models\",\n \"download_model_all_models\",\n \"change_model_settings_all_models\"\n ],\n models: []\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/project.js", + "groupTitle": "Project" + }, + { + "type": "delete", + "url": "/:teamspace/projects/:project", + "title": "Delete project", + "name": "deleteProject", + "group": "Project", + "description": "

Deletes a project, including all the models and federations inside of it.

", + "permission": [ + { + "name": "canDeleteProject" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of the teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "project", + "description": "

Project to delete

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "DELETE /teamSpace1/projects/Classic%20project%20renamed HTTP/1.1", + "type": "delete" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n _id: \"5d5bec491c15383184eb7521\",\n name: \"Classic project renamed\",\n permissions: [\n {\n user: \"projectshared\",\n permissions: [\n \"admin_project\"\n ]\n }\n ],\n models: []\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/project.js", + "groupTitle": "Project" + }, + { + "type": "get", + "url": "/:teamspace/projects/:project/models", + "title": "List models of the project", + "name": "listModels", + "group": "Project", + "description": "

It returns a list of models .

", + "permission": [ + { + "name": "canListProjects" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of the teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "project", + "description": "

The name of the project to list models

" + } + ], + "Query": [ + { + "group": "Query", + "type": "String", + "optional": true, + "field": "name", + "description": "

Filters models by name

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/projects/Bim%20Logo/models?name=log HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "[\n {\n \"_id\": \"5ce7dd19-1252-4548-a9c9-4a5414f2e0c5\",\n \"federate\": true,\n \"desc\": \"\",\n \"name\": \"Full Logo\",\n \"__v\": 17,\n \"timestamp\": \"2019-05-02T16:17:37.902Z\",\n \"type\": \"Federation\",\n \"subModels\": [\n {\n \"database\": \"teamSpace1\",\n \"model\": \"b1fceab8-b0e9-4e45-850b-b9888efd6521\",\n \"name\": \"block\"\n },\n {\n \"database\": \"teamSpace1\",\n \"model\": \"7cf61b4f-acdf-4295-b2d0-9b45f9f27418\",\n \"name\": \"letters\"\n },\n {\n \"database\": \"teamSpace1\",\n \"model\": \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\",\n \"name\": \"pipes\"\n }\n ],\n \"surveyPoints\": [\n {\n \"position\": [\n 0,\n 0,\n 0\n ],\n \"latLong\": [\n -34.459127,\n 0\n ]\n }\n ],\n \"properties\": {\n \"unit\": \"mm\",\n \"topicTypes\": [\n {\n \"label\": \"Clash\",\n \"value\": \"clash\"\n },\n {\n \"label\": \"Diff\",\n \"value\": \"diff\"\n },\n {\n \"label\": \"RFI\",\n \"value\": \"rfi\"\n },\n {\n \"label\": \"Risk\",\n \"value\": \"risk\"\n },\n {\n \"label\": \"H&S\",\n \"value\": \"hs\"\n },\n {\n \"label\": \"Design\",\n \"value\": \"design\"\n },\n {\n \"label\": \"Constructibility\",\n \"value\": \"constructibility\"\n },\n {\n \"label\": \"GIS\",\n \"value\": \"gis\"\n },\n {\n \"label\": \"For information\",\n \"value\": \"for_information\"\n },\n {\n \"label\": \"VR\",\n \"value\": \"vr\"\n }\n ]\n },\n \"permissions\": [\n \"change_model_settings\",\n \"upload_files\",\n \"create_issue\",\n \"comment_issue\",\n \"view_issue\",\n \"view_model\",\n \"download_model\",\n \"edit_federation\",\n \"delete_federation\",\n \"delete_model\",\n \"manage_model_permission\"\n ],\n \"status\": \"ok\",\n \"id\": \"5ce7dd19-1252-4548-a9c9-4a5414f2e0c5\",\n \"model\": \"5ce7dd19-1252-4548-a9c9-4a5414f2e0c5\",\n \"account\": \"teamSpace1\",\n \"headRevisions\": {\n }\n }\n]\t *", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/project.js", + "groupTitle": "Project" + }, + { + "type": "get", + "url": "/:teamspace/projects/:project", + "title": "Get project", + "name": "listProject", + "group": "Project", + "description": "

Get the details of a project; name, user permissions, modelids.

", + "permission": [ + { + "name": "canViewProject" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of the teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "project", + "description": "

Project name to be queried

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/projects/Classic%20project%20renamed HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "{\n _id: \"5d5bec491c15383184eb7521\",\n name: \"Classic project renamed\",\n permissions: [\n {\n user: \"projectshared\",\n permissions: [\n \"admin_project\"\n ]\n },\n {\n user: \"viewerTeamspace1Model1JobA\",\n permissions: []\n },\n {\n user: \"commenterTeamspace1Model1JobB\",\n permissions: []\n },\n {\n user: \"collaboratorTeamspace1Model1JobA\",\n permissions: []\n }\n ],\n models: []\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/project.js", + "groupTitle": "Project" + }, + { + "type": "get", + "url": "/:teamspace/projects", + "title": "List projects", + "name": "listProjects", + "group": "Project", + "description": "

It returns a list of projects with their permissions and model ids.

", + "permission": [ + { + "name": "canListProjects" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of the teamspace

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/projects HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success:", + "content": "[\n {\n _id: \"5ccb1490b4626d30c05c9401\",\n name: \"Medieval\",\n permissions: [\n {\n user: \"projectshared\",\n permissions: []\n },\n {\n user: \"fed\",\n permissions: []\n },\n {\n user: \"teamSpace1\",\n permissions: []\n },\n {\n user: \"weirdTeamspace\",\n permissions: []\n }\n ],\n models: [\n \"50926a1f-1525-44ac-b6a1-d016949a13bb\"\n ]\n },\n {\n _id: \"5ccb1702b4626d30c05c9830\",\n name: \"Bim Logo\",\n permissions: [\n {\n user: \"projectshared\",\n permissions: []\n },\n {\n user: \"commenterTeamspace1Model1JobA\",\n permissions: []\n },\n {\n user: \"commenterTeamspace1Model1JobB\",\n permissions: []\n },\n {\n user: \"collaboratorTeamspace1Model1JobA\",\n permissions: []\n },\n {\n user: \"collaboratorTeamspace1Model1JobB\",\n permissions: []\n },\n {\n user: \"adminTeamspace1JobA\",\n permissions: []\n },\n {\n user: \"adminTeamspace1JobB\",\n permissions: []\n },\n {\n user: \"weirdTeamspace\",\n permissions: []\n }\n ],\n models: [\n \"2710bd65-37d3-4e7f-b2e0-ffe743ce943f\",\n \"b1fceab8-b0e9-4e45-850b-b9888efd6521\",\n \"7cf61b4f-acdf-4295-b2d0-9b45f9f27418\",\n \"5ce7dd19-1252-4548-a9c9-4a5414f2e0c5\"\n ]\n },\n {\n _id: \"5d5bec491c15383184eb7521\",\n name: \"Classic project renamed\",\n permissions: [\n {\n user: \"projectshared\",\n permissions: [\n \"admin_project\"\n ]\n },\n {\n user: \"viewerTeamspace1Model1JobA\",\n permissions: []\n },\n {\n user: \"commenterTeamspace1Model1JobB\",\n permissions: []\n },\n {\n user: \"collaboratorTeamspace1Model1JobA\",\n permissions: []\n }\n ],\n models: []\n }\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/project.js", + "groupTitle": "Project" + }, + { + "type": "patch", + "url": "/:teamspace/projects/:project", + "title": "Update project", + "name": "updateProject", + "group": "Project", + "description": "

Update project properties (name, permissions)

", + "permission": [ + { + "name": "canUpdateProject" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "project", + "description": "

Name of project

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "name", + "description": "

Project name

" + }, + { + "group": "Request body", + "type": "ProjectPermission[]", + "optional": true, + "field": "permissions", + "description": "

List of user permissions

" + } + ], + "Type: ProjectPermission": [ + { + "group": "Type: ProjectPermission", + "type": "String", + "optional": false, + "field": "user", + "description": "

Username of user

" + }, + { + "group": "Type: ProjectPermission", + "type": "String[]", + "optional": false, + "field": "permissions", + "description": "

List of user privileges

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage (update permissions):", + "content": "PATCH /acme/ProjectAnvil HTTP/1.1\n{\n permissions: [\n {\n user: \"alice\",\n permissions: [\n \"admin_project\"\n ]\n },\n {\n user: \"mike\",\n permissions: []\n }\n ]\n}", + "type": "patch" + }, + { + "title": "Example usage (rename project):", + "content": "PATCH /acme/ProjectAnvil HTTP/1.1\n{\n name: \"ProjectInstantTunnel\"\n}", + "type": "patch" + }, + { + "title": "Example usage:", + "content": "PATCH /acme/ProjectInstantTunnel HTTP/1.1\n{\n name: \"Project Trebuchet\",\n permissions: [\n {\n user: \"bob\",\n permissions: [\n \"admin_project\"\n ]\n }\n ]\n}", + "type": "patch" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response:", + "content": "{\n status: \"ok\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/project.js", + "groupTitle": "Project" + }, + { + "type": "put", + "url": "/:teamspace/projects/:project", + "title": "Update project", + "name": "updateProjectPut", + "group": "Project", + "description": "

It updates a project. The name can be changed and the permissions as well as the permissions of users

", + "deprecated": { + "content": "use now (#Project:updateProject)" + }, + "permission": [ + { + "name": "canUpdateProject" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of the teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "project", + "description": "

The name of the project to update

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "name", + "description": "

The name of the project to be created

" + }, + { + "group": "Request body", + "type": "[]Permission", + "optional": false, + "field": "permissions", + "description": "

The permissions for each user from the project

" + } + ], + "Request body: Permissions": [ + { + "group": "Request body: Permissions", + "type": "String", + "optional": false, + "field": "user", + "description": "

The username of the user to have it permission changed

" + }, + { + "group": "Request body: Permissions", + "type": "String[]", + "optional": false, + "field": "permissions", + "description": "

An array of permissions for the user to be assigned

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage update permissions:", + "content": "PUT /teamSpace1/Classic%20project HTTP/1.1\n{\n name: \"Classic project\",\n permissions: [\n {\n user: \"projectshared\",\n permissions: [\n \"admin_project\"\n ]\n },\n {\n user: \"viewerTeamspace1Model1JobA\",\n permissions: []\n },\n {\n user: \"commenterTeamspace1Model1JobB\",\n permissions: []\n },\n {\n user: \"collaboratorTeamspace1Model1JobA\",\n permissions: []\n }\n ]\n}", + "type": "put" + }, + { + "title": "Example usage rename project:", + "content": "PUT /teamSpace1/Classic%20project HTTP/1.1\n{name: \"Classic project renamed\"}", + "type": "put" + } + ], + "success": { + "examples": [ + { + "title": "Success update permissions:", + "content": "{\n _id: \"5d5bec491c15383184eb7521\",\n name: \"Classic project\",\n permissions: [\n {\n user: \"projectshared\",\n permissions: [\n \"admin_project\"\n ]\n }\n ],\n models: []\n}", + "type": "json" + }, + { + "title": "Success rename project:", + "content": "{\n _id: \"5d5bec491c15383184eb7521\",\n name: \"Classic project renamed\",\n permissions: [\n {\n user: \"projectshared\",\n permissions: [\n \"admin_project\"\n ]\n }\n ],\n models: []\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/project.js", + "groupTitle": "Project" + }, + { + "type": "get", + "url": "/:teamspace/:model/resources/:resourceId", + "title": "Get resource file", + "name": "getResource", + "group": "Resources", + "description": "

Is the URL for downloading the resource file identified by the resourceId.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "resourceId", + "description": "

The Id of the resource

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/resources.js", + "groupTitle": "Resources" + }, + { + "type": "post", + "url": "/:teamspace/:model/risks/:riskId/resources", + "title": "Attach resources to a risk", + "name": "attachResourceRisk", + "group": "Risks", + "description": "

Attaches file or URL resources to a risk. If the type of the resource is file it should be sent as multipart/form-data. Both types at the same time cannot be sent. So in order to attach files and URLs it should be done with two different requests.

This method triggers a chat event

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "riskId", + "description": "

Risk ID

" + } + ], + "Request body file resource (multipart/form-data)": [ + { + "group": "Request body file resource (multipart/form-data)", + "type": "File[]", + "optional": false, + "field": "files", + "description": "

The array of files to be attached

" + }, + { + "group": "Request body file resource (multipart/form-data)", + "type": "String[]", + "optional": false, + "field": "names", + "description": "

The names of the files; it should have the same length as the files field and should include the file extension

" + } + ], + "Request body URL resource": [ + { + "group": "Request body URL resource", + "type": "String[]", + "optional": false, + "field": "urls", + "description": "

The array of URLs to be attached

" + }, + { + "group": "Request body URL resource", + "type": "String[]", + "optional": false, + "field": "names", + "description": "

The names of the URLs; it should have the same length as the URL field

" + } + ] + } + }, + "success": { + "examples": [ + { + "title": "Success example result after two files has been uploaded", + "content": "\n[\n {\n \"_id\":\"7617f775-9eb7-4877-8ec3-98ea3457e519\",\n \"size\":1422,\n \"riskIds\":[\n \"3e8a11e0-9812-11e9-9c4d-ebde5888e062\"\n ],\n \"name\":\"todo.txt\",\n \"user\":\"teamSpace1\",\n \"createdAt\":1561973996461\n },\n {\n \"_id\":\"e25e42d5-c4f0-4fbc-a8f4-bc9899e6662a\",\n \"size\":2509356,\n \"riskIds\":[\n \"3e8a11e0-9812-11e9-9c4d-ebde5888e062\"\n ],\n \"name\":\"football.gif\",\n \"user\":\"teamSpace1\",\n \"createdAt\":1561973996462\n }\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/risk.js", + "groupTitle": "SafetiBase Risks" + }, + { + "type": "post", + "url": "/:teamspace/:model/risks/:riskId/comments", + "title": "Add a comment", + "name": "commentRisk", + "group": "Risks", + "description": "

Create a comment in a risk.

", + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "_id", + "description": "

Risk ID

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "rev_id", + "description": "

Revision ID

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "comment", + "description": "

Comment text

" + }, + { + "group": "Request body", + "type": "Viewpoint", + "optional": false, + "field": "viewpoint", + "description": "

Viewpoint object

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "riskId", + "description": "

Risk ID

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "guid", + "description": "

Comment ID

" + }, + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "created", + "description": "

Comment creation timestamp

" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "owner", + "description": "

Comment owner

" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "comment", + "description": "

Comment text

" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "viewpoint", + "description": "

Viewpoint object

" + } + ] + }, + "examples": [ + { + "title": "Success-Response.", + "content": "HTTP/1.1 200 OK\n{\n\t\"guid\":\"00000000-0000-0000-0000-000000000007\",\n\t\"created\":1567172228143,\n\t\"owner\":\"alice\",\n\t\"comment\":\"Comment 1\",\n\t\"viewpoint\":{\n\t\t\"right\":[0.5,-0.1,0.5],\n\t\t\"up\":[0.3,0.9,-0.3],\n\t\t\"position\":[-50000.0,100000.0,150000.0],\n\t\t\"look_at\":[35000.0,50000.0,9000.0],\n\t\t\"view_dir\":[0.5,-0.5,-1.0],\n\t\t\"near\":500.0,\n\t\t\"far\":300000,\n\t\t\"fov\":1.05,\n\t\t\"aspect_ratio\":1.5,\n\t\t\"clippingPlanes\":[],\n\t\t\"screenshot\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/viewpoints/00000000-0000-0000-0000-000000000005/screenshot.png\",\n\t\t\"guid\":\"00000000-0000-0000-0000-000000000006\",\n\t\t\"screenshotSmall\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/viewpoints/00000000-0000-0000-0000-000000000005/screenshotSmall.png\"\n\t}\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/comments HTTP/1.1\n{\n\t\"_id\":\"00000000-0000-0000-0000-000000000002\",\n\t\"rev_id\":\"00000000-0000-0000-0000-000000000001\",\n\t\"comment\":\"Comment 1\",\n\t\"viewpoint\":{\n\t\t\"right\":[0.5,-0.1,0.5],\n\t\t\"up\":[0.3,0.9,-0.3],\n\t\t\"position\":[-50000.0,100000.0,150000.0],\n\t\t\"look_at\":[35000.0,50000.0,9000.0],\n\t\t\"view_dir\":[0.5,-0.5,-1.0],\n\t\t\"near\":500.0,\n\t\t\"far\":300000,\n\t\t\"fov\":1.05,\n\t\t\"aspect_ratio\":1.5,\n\t\t\"clippingPlanes\":[],\n\t\t\"highlighted_group_id\":\"\",\n\t\t\"screenshot\":\n\t}\n}", + "type": "post" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/risk.js", + "groupTitle": "SafetiBase Risks" + }, + { + "type": "delete", + "url": "/:teamspace/:model/risks/:riskId/comments", + "title": "Delete a comment", + "name": "deleteComment", + "group": "Risks", + "description": "

Delete a risk comment.

", + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "guid", + "description": "

Comment ID

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "riskId", + "description": "

Risk ID

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "DELETE /acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/comments HTTP/1.1\n{\n\t\"guid\":\"00000000-0000-0000-0000-000000000007\",\n}", + "type": "delete" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response.", + "content": "HTTP/1.1 200 OK\n{\n\t\"guid\":\"00000000-0000-0000-0000-000000000007\",\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/risk.js", + "groupTitle": "SafetiBase Risks" + }, + { + "type": "delete", + "url": "/:teamspace/:model/risks/:riskId/resources", + "title": "Detach a resource from a risk", + "name": "detachResourceRisk", + "group": "Risks", + "description": "

Detachs a resource from a risk. If the risk is the last entity the resources has been attached to it also deletes the resource from the system. This method triggers a chat event .

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "riskId", + "description": "

Risk ID

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "_id", + "description": "

The resource id to be detached

" + } + ] + } + }, + "success": { + "examples": [ + { + "title": "{", + "content": "\n{\n \"_id\":\"e25e42d5-c4f0-4fbc-a8f4-bc9899e6662a\",\n \"size\":2509356,\n \"riskIds\":[\n ],\n \"name\":\"football.gif\",\n \"user\":\"teamSpace1\",\n \"createdAt\":1561973996462\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/risk.js", + "groupTitle": "SafetiBase Risks" + }, + { + "type": "get", + "url": "/:teamspace/mitigations/criteria", + "title": "Get mitigation criteria", + "name": "findMitigationCriteria", + "group": "Risks", + "description": "

Returns all mitigations criteria from mitigation suggestions.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/mitigations/criteria HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response.", + "content": "HTTP/1.1 200 OK\n{\n\t\"associated_activity\":[\n\t\t\"All construction\",\n\t\t\"Site tests\",\n\t\t\"Logistics\"\n\t],\n\t\"category\":[\n\t\t\"safety_electricity\"\n\t],\n\t\"element\":[\n\t\t\"Doors\",\n\t\t\"Floors\",\n\t\t\"Pipes\",\n\t\t\"Vents\",\n\t\t\"Walls\"\n\t],\n\t\"location_desc\":[\n\t\t\"Tower 1 - Level 0\",\n\t\t\"Tower 1 - Level 1\",\n\t\t\"Tower 1 - Level 2\",\n\t\t\"Tower 2 - Level 0\",\n\t\t\"Tower 2 - Level 1\",\n\t\t\"Tower 3 - Level 0\",\n\t\t\"Tower 3 - Level 1\",\n\t\t\"Tower 3 - Level 2\"\n\t],\n\t\"mitigation_stage\":[\n\t\t\"Preliminary Design\",\n\t\t\"Detail Design\",\n\t\t\"Preconstruction\",\n\t\t\"Site work and Change Control\"\n\t],\n\t\"mitigation_type\":[\n\t\t\"Eliminate\",\n\t\t\"Reduce\",\n\t\t\"Control\",\n\t\t\"Inform\"\n\t],\n\t\"risk_factor\":[\n\t\t\"Factor 2\",\n\t\t\"Factor 5\",\n\t\t\"Factor 8\"\n\t],\n\t\"scope\":[\n\t\t\"General concrete\",\n\t\t\"In situ concrete\"\n\t]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/mitigation.js", + "groupTitle": "SafetiBase Risks" + }, + { + "type": "post", + "url": "/:teamspace/mitigations", + "title": "Find mitigation suggestions", + "name": "findMitigationSuggestions", + "group": "Risks", + "description": "

Returns a list of suggestions for risk mitigation based on given criteria.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "associated_activity", + "description": "

Risk associated activity

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "category", + "description": "

Risk category

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "element", + "description": "

Risk element type

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "location_desc", + "description": "

Risk location description

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "risk_factor", + "description": "

Risk factor

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "scope", + "description": "

Risk construction scope

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /acme/mitigations HTTP/1.1\n{\n\t\"associated_activity\":\"\",\n\t\"category\":\"safety_fall\",\n\t\"element\":\"Doors\",\n\t\"location_desc\":\"Tower 3 - Level 2\",\n\t\"risk_factor\":\"Factor 9\",\n\t\"scope\":\"Tower 3\"\n}", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response.", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"mitigation_desc\":\"Replace all openings required in floor slabs with precast service openings.\",\n\t\t\"mitigation_detail\":\"Replace openings larger than a standard anvil required in floor slabs with precast service openings from A/W 2020 catalogue.\",\n\t\t\"mitigation_stage\":\"Preliminary Design\",\n\t\t\"mitigation_type\":\"Eliminate\"\n\t},\n\t{\n\t\t\"mitigation_desc\":\"Provide safe walking surface joint covers. Any covering should be: strong enough to support any loads likely to be placed on it ; and fixed in position to prevent accidental dislodgement.\",\n\t\t\"mitigation_detail\":\"Safe walking surface joint covers for all joins and gaps. Covers should be strong enough to support any loads likely to be placed on it and fixed in position with bolts to prevent accidental dislodgement.\",\n\t\t\"mitigation_stage\":\"Detail Design\",\n\t\t\"mitigation_type\":\"Reduce\"\n\t},\n\t{\n\t\t\"mitigation_desc\":\"Provide warning markings and/or colour change.\",\n\t\t\"mitigation_detail\":\"Provide warning markings from approved list of markings and/or colour change using chart from Document XYZ.\",\n\t\t\"mitigation_stage\":\"Preconstruction\",\n\t\t\"mitigation_type\":\"Control\"\n\t}\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/mitigation.js", + "groupTitle": "SafetiBase Risks" + }, + { + "type": "get", + "url": "/:teamspace/:model/risks/:riskId", + "title": "Get a risk", + "name": "findRiskById", + "group": "Risks", + "description": "

Retrieve a risk. The response includes all comments and screenshot URLs.

", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "risk", + "description": "

The Issue matching the Issue ID

" + } + ] + }, + "examples": [ + { + "title": "Success-Response.", + "content": "HTTP/1.1 200 OK\n{\n\t\"_id\":\"00000000-0000-0000-0000-000000000002\",\n\t\"account\":\"acme\",\n\t\"assigned_roles\":[\n\t\t\"Job1\"\n\t],\n\t\"associated_activity\":\"Column casting\",\n\t\"category\":\"safety_fall\",\n\t\"comments\":[],\n\t\"consequence\":0,\n\t\"created\":1567156228976,\n\t\"creator_role\":\"Job4\",\n\t\"desc\":\"Risk description that describes the risk\",\n\t\"element\":\"Doors\",\n\t\"level_of_risk\":0,\n\t\"likelihood\":0,\n\t\"location_desc\":\"Tower 3 - Level 2\",\n\t\"mitigation_desc\":\"Erect temporary barrier\",\n\t\"mitigation_detail\":\"Erect a temporary 1.5m metal barrier along edge\",\n\t\"mitigation_stage\":\"Construction stage 5\",\n\t\"mitigation_status\":\"proposed\",\n\t\"mitigation_type\":\"Eliminate\",\n\t\"model\":\"00000000-0000-0000-0000-000000000000\",\n\t\"name\":\"Risk 1\",\n\t\"overall_level_of_risk\":0,\n\t\"owner\":\"alice\",\n\t\"position\":[55000.0,80000.0,-10000.0],\n\t\"residual_consequence\":-1,\n\t\"residual_level_of_risk\":-1,\n\t\"residual_likelihood\":-1,\n\t\"residual_risk\":\"\",\n\t\"rev_id\":\"00000000-0000-0000-0000-000000000001\",\n\t\"risk_factor\":\"Factor 9\",\n\t\"safetibase_id\":\"\",\n\t\"scope\":\"Tower 3\",\n\t\"thumbnail\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/thumbnail.png\",\n\t\"viewpoint\":{\n\t\t\"aspect_ratio\":1.4,\n\t\t\"clippingPlanes\":[],\n\t\t\"far\":300000,\n\t\t\"fov\":1.05,\n\t\t\"guid\":\"00000000-0000-0000-0000-000000000004\",\n\t\t\"hideIfc\":true,\n\t\t\"look_at\":[35000.0,40000.0,8000.0],\n\t\t\"near\":600.0,\n\t\t\"position\":[-70000.0,120000.0,150000.0],\n\t\t\"right\":[0.8,-0.3,0.6],\n\t\t\"screenshot\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/viewpoints/00000000-0000-0000-0000-000000000003/screenshot.png\",\n\t\t\"screenshotSmall\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/viewpoints/00000000-0000-0000-0000-000000000003/screenshotSmall.png\",\n\t\t\"up\":[0.3,0.9,-0.3],\n\t\t\"view_dir\":[0.5,-0.4,-0.7]\n\t}\n}", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002 HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/risk.js", + "groupTitle": "SafetiBase Risks", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "riskId", + "description": "

Risk ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/risks/:riskId/screenshot.png", + "title": "Get risk screenshot", + "name": "getScreenshot", + "group": "Risks", + "description": "

Retrieve a risk screenshot image.

", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Screenshot image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/screenshot.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/risk.js", + "groupTitle": "SafetiBase Risks", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "riskId", + "description": "

Risk ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/risks/:riskId/screenshotSmall.png", + "title": "Get low-res screenshot", + "name": "getScreenshotSmall", + "group": "Risks", + "description": "

Retrieve a low-resolution risk screenshot image.

", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Small screenshot image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/screenshotSmall.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/risk.js", + "groupTitle": "SafetiBase Risks", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "riskId", + "description": "

Risk ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/risks/:riskId/thumbnail.png", + "title": "Get risk thumbnail", + "name": "getThumbnail", + "group": "Risks", + "description": "

Retrieve a risk thumbnail image.

", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "png", + "optional": false, + "field": "image", + "description": "

Thumbnail image

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/thumbnail.png HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/risk.js", + "groupTitle": "SafetiBase Risks", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "riskId", + "description": "

Risk ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model[/revision/:revId]/risks", + "title": "List all risks", + "name": "listRisks", + "group": "Risks", + "description": "

Retrieve all model risks.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "revId", + "description": "

Revision ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Query": [ + { + "group": "Query", + "type": "Number", + "optional": true, + "field": "updatedSince", + "description": "

Only return issues that has been updated since this value (in epoch value)

" + }, + { + "group": "Query", + "type": "Number[]", + "optional": true, + "field": "numbers", + "description": "

Array of issue numbers to filter for

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "ids", + "description": "

Array of issue ids to filter for

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "categories", + "description": "

Array of categories to filter for

" + }, + { + "group": "Query", + "type": "String[]", + "optional": true, + "field": "mitigationStatus", + "description": "

Array of mitigation status to filter for

" + }, + { + "group": "Query", + "type": "Number[]", + "optional": true, + "field": "likelihoods", + "description": "

Array of likelihoods to filter for. The possible number values for this fields are UNSET: -1, VERY_LOW: 0, LOW: 1, MODERATE: 2, HIGH: 3, VERY_HIGH: 4 .

" + }, + { + "group": "Query", + "type": "Number[]", + "optional": true, + "field": "consequences", + "description": "

Array of consequences to filter for. The possible number values for this fields are UNSET: -1, VERY_LOW: 0, LOW: 1, MODERATE: 2, HIGH: 3, VERY_HIGH: 4 .

" + }, + { + "group": "Query", + "type": "Number[]", + "optional": true, + "field": "residualLikelihoods", + "description": "

Array of residual likelihoods to filter for. The possible number values for this fields are UNSET: -1, VERY_LOW: 0, LOW: 1, MODERATE: 2, HIGH: 3, VERY_HIGH: 4 .

" + }, + { + "group": "Query", + "type": "Number[]", + "optional": true, + "field": "levelOfRisks", + "description": "

Array of levels of risks to filter for. The possible number values for this fields are UNSET: -1, VERY_LOW: 0, LOW: 1, MODERATE: 2, HIGH: 3, VERY_HIGH: 4 .

" + }, + { + "group": "Query", + "type": "Number[]", + "optional": true, + "field": "residualConsequences", + "description": "

Array of residual consequences to filter for. The possible number values for this fields are UNSET: -1, VERY_LOW: 0, LOW: 1, MODERATE: 2, HIGH: 3, VERY_HIGH: 4 .

" + }, + { + "group": "Query", + "type": "Number[]", + "optional": true, + "field": "residualLevelOfRisks", + "description": "

Array of levels of risks to filter for. The possible number values for this fields are UNSET: -1, VERY_LOW: 0, LOW: 1, MODERATE: 2, HIGH: 3, VERY_HIGH: 4 .

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "Object[]", + "optional": false, + "field": "risks", + "description": "

Risk objects

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"_id\":\"00000000-0000-0000-0000-000000000002\",\n\t\t\"account\":\"acme\",\n\t\t\"assigned_roles\":[\n\t\t\t\"Job1\"\n\t\t],\n\t\t\"associated_activity\":\"Column casting\",\n\t\t\"category\":\"safety_fall\",\n\t\t\"comments\":[],\n\t\t\"consequence\":0,\n\t\t\"created\":1567156228976,\n\t\t\"creator_role\":\"Job4\",\n\t\t\"desc\":\"Risk description that describes the risk\",\n\t\t\"element\":\"Doors\",\n\t\t\"level_of_risk\":0,\n\t\t\"likelihood\":0,\n\t\t\"location_desc\":\"Tower 3 - Level 2\",\n\t\t\"mitigation_desc\":\"Erect temporary barrier\",\n\t\t\"mitigation_detail\":\"Erect a temporary 1.5m metal barrier along edge\",\n\t\t\"mitigation_stage\":\"Construction stage 5\",\n\t\t\"mitigation_status\":\"proposed\",\n\t\t\"mitigation_type\":\"Eliminate\",\n\t\t\"model\":\"00000000-0000-0000-0000-000000000000\",\n\t\t\"name\":\"Risk 1\",\n\t\t\"overall_level_of_risk\":0,\n\t\t\"owner\":\"alice\",\n\t\t\"position\":[55000.0,80000.0,-10000.0],\n\t\t\"residual_consequence\":-1,\n\t\t\"residual_level_of_risk\":-1,\n\t\t\"residual_likelihood\":-1,\n\t\t\"residual_risk\":\"\",\n\t\t\"rev_id\":\"00000000-0000-0000-0000-000000000001\",\n\t\t\"risk_factor\":\"Factor 9\",\n\t\t\"safetibase_id\":\"\",\n\t\t\"scope\":\"Tower 3\",\n\t\t\"thumbnail\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/thumbnail.png\",\n\t\t\"viewpoint\":{\n\t\t\t\"aspect_ratio\":1.4,\n\t\t\t\"clippingPlanes\":[],\n\t\t\t\"far\":300000,\n\t\t\t\"fov\":1.05,\n\t\t\t\"guid\":\"00000000-0000-0000-0000-000000000004\",\n\t\t\t\"hideIfc\":true,\n\t\t\t\"look_at\":[35000.0,40000.0,8000.0],\n\t\t\t\"near\":600.0,\n\t\t\t\"position\":[-70000.0,120000.0,150000.0],\n\t\t\t\"right\":[0.8,-0.3,0.6],\n\t\t\t\"screenshot\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/viewpoints/00000000-0000-0000-0000-000000000003/screenshot.png\",\n\t\t\t\"screenshotSmall\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/viewpoints/00000000-0000-0000-0000-000000000003/screenshotSmall.png\",\n\t\t\t\"up\":[0.3,0.9,-0.3],\n\t\t\t\"view_dir\":[0.5,-0.4,-0.7]\n\t\t}\n\t}\n]", + "type": "json" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/risks HTTP/1.1", + "type": "get" + }, + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/revision/00000000-0000-0000-0000-000000000001/risks HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/risk.js", + "groupTitle": "SafetiBase Risks" + }, + { + "type": "get", + "url": "/:teamspace/:model[/revision/:revId]/risks.html", + "title": "Render risks as HTML", + "name": "renderRisksHTML", + "group": "Risks", + "description": "

Retrieve HTML page of all risks.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "revId", + "description": "

Revision ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Query": [ + { + "group": "Query", + "type": "String", + "optional": false, + "field": "ids", + "description": "

Risk IDs to show

" + } + ] + } + }, + "success": { + "fields": { + "200": [ + { + "group": "200", + "type": "Object[]", + "optional": false, + "field": "risks", + "description": "

Risk objects

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "html" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/risks.html?[query] HTTP/1.1", + "type": "get" + }, + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/revision/00000000-0000-0000-0000-000000000001/risks.html?[query] HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/risk.js", + "groupTitle": "SafetiBase Risks" + }, + { + "type": "post", + "url": "/:teamspace/:model[/revision/:revId]/risks", + "title": "Create a risk", + "name": "storeRisk", + "group": "Risks", + "description": "

Create a model risk.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "revId", + "description": "

Revision ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "name", + "description": "

Risk name

" + }, + { + "group": "Request body", + "type": "String[]", + "optional": false, + "field": "assigned_roles", + "description": "

Risk owner

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "associated_activity", + "description": "

Associated activity

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "category", + "description": "

Category

" + }, + { + "group": "Request body", + "type": "Number", + "optional": false, + "field": "consequence", + "description": "

Risk consequence (0: very low, 1: low, 2: moderate, 3: high, 4: very high)

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "desc", + "description": "

Risk description

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "element", + "description": "

Element type

" + }, + { + "group": "Request body", + "type": "Number", + "optional": false, + "field": "likelihood", + "description": "

Risk likelihood (0: very low, 1: low, 2: moderate, 3: high, 4: very high)

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "location_desc", + "description": "

Location description

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "mitigation_status", + "description": "

Treatment status

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "mitigation_desc", + "description": "

Treatment summary

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "mitigation_detail", + "description": "

Treatment detailed description

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "mitigation_stage", + "description": "

Treatment stage

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "mitigation_type", + "description": "

Treatment type

" + }, + { + "group": "Request body", + "type": "Number[3]", + "optional": false, + "field": "position", + "description": "

Risk pin coordinates

" + }, + { + "group": "Request body", + "type": "Number", + "optional": false, + "field": "residual_consequence", + "description": "

Treated risk consequence (-1: unset, 0: very low, 1: low, 2: moderate, 3: high, 4: very high)

" + }, + { + "group": "Request body", + "type": "Number", + "optional": false, + "field": "residual_likelihood", + "description": "

Treated risk likelihood (-1: unset, 0: very low, 1: low, 2: moderate, 3: high, 4: very high)

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "residual_risk", + "description": "

Residual risk

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "risk_factor", + "description": "

Risk factor

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "scope", + "description": "

Construction scope

" + }, + { + "group": "Request body", + "type": "Viewpoint", + "optional": false, + "field": "viewpoint", + "description": "

Viewpoint

" + } + ], + "Type: Viewpoint": [ + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "right", + "description": "

Right vector of viewpoint indicating the direction of right in relative coordinates

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "up", + "description": "

Up vector of viewpoint indicating the direction of up in relative coordinates

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "position", + "description": "

Position vector indicates where in the world the viewpoint is positioned

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "look_at", + "description": "

Vector indicating where in the world the viewpoint is looking at

" + }, + { + "group": "Type: Viewpoint", + "type": "Number[3]", + "optional": false, + "field": "view_dir", + "description": "

Vector indicating the direction the viewpoint is looking at in relative coordinates

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "near", + "description": "

Vector indicating the near plane

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "far", + "description": "

Vector indicating the far plane

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "fov", + "description": "

Angle of the field of view

" + }, + { + "group": "Type: Viewpoint", + "type": "Number", + "optional": false, + "field": "aspect_ratio", + "description": "

Aspect ratio of the fustrum

" + }, + { + "group": "Type: Viewpoint", + "type": "ClippingPlane[]", + "optional": true, + "field": "clippingPlanes", + "description": "

Clipping planes associated with the viewpoint

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": true, + "field": "highlighted_group_id", + "description": "

If the viewpoint is associated with one or more highlighted objects from the model this field has the value of a group ID generated to hold those objects

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": true, + "field": "hidden_group_id", + "description": "

If the viewpoint is associated with one or more hidden objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": true, + "field": "shown_group_id", + "description": "

If the viewpoint is associated with one or more shown objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: Viewpoint", + "type": "Group", + "optional": true, + "field": "highlighted_group", + "description": "

If the viewpoint is associated with one or more highlighted objects from the model this field has the value of a group definition for those objects (this shouldnt be use simultaneously with highlighted_group_id)

" + }, + { + "group": "Type: Viewpoint", + "type": "Group", + "optional": true, + "field": "hidden_group", + "description": "

If the viewpoint is associated with one or more hidden objects from the model this field has the value of a group id generated to hold those objects (this shouldnt be use simultaneously with hidden_group_id)

" + }, + { + "group": "Type: Viewpoint", + "type": "Group", + "optional": true, + "field": "shown_group", + "description": "

If the viewpoint is associated with one or more shown objects from the model this field has the definition of the group to hold those objects (this shouldnt be use simultaneously with shown_group_id)

" + }, + { + "group": "Type: Viewpoint", + "type": "Group[]", + "optional": true, + "field": "override_groups", + "description": "

If the viewpoint has one or more objects with colour override this field has an array of groups with one group for each colour

" + }, + { + "group": "Type: Viewpoint", + "type": "Group[]", + "optional": true, + "field": "transformation_groups", + "description": "

List of groups with transformations

" + }, + { + "group": "Type: Viewpoint", + "type": "String[]", + "optional": true, + "field": "transformation_group_ids", + "description": "

List of group IDs with transformations

" + }, + { + "group": "Type: Viewpoint", + "type": "Boolean", + "optional": false, + "field": "hide_IFC", + "description": "

A flag to hide the IFC

" + }, + { + "group": "Type: Viewpoint", + "type": "String", + "optional": false, + "field": "screenshot", + "description": "

Base64 string representing the screenshot associated with the viewpoint

" + } + ], + "Type: Group": [ + { + "group": "Type: Group", + "type": "Number[3]", + "optional": false, + "field": "color", + "description": "

RGB colour values

" + }, + { + "group": "Type: Group", + "type": "ModelObjects", + "optional": false, + "field": "objects", + "description": "

List of objects in group

" + } + ], + "Type: ModelObjects": [ + { + "group": "Type: ModelObjects", + "type": "String", + "optional": false, + "field": "account", + "description": "

The account that has the model which contains the objects

" + }, + { + "group": "Type: ModelObjects", + "type": "String", + "optional": false, + "field": "model", + "description": "

The model id that contains the objects

" + }, + { + "group": "Type: ModelObjects", + "type": "String[]", + "optional": false, + "field": "shared_ids", + "description": "

The shared ids of objects to be selected

" + } + ], + "Type: ClippingPlane": [ + { + "group": "Type: ClippingPlane", + "type": "Number[3]", + "optional": false, + "field": "normal", + "description": "

The normal of the plane defined for the clipping plane

" + }, + { + "group": "Type: ClippingPlane", + "type": "Number", + "optional": false, + "field": "distance", + "description": "

The distance for the clipping plane to the origin

" + }, + { + "group": "Type: ClippingPlane", + "type": "Number", + "optional": false, + "field": "clipDirection", + "description": "

The direction to the clipping plane will cut the model; above or below the plane. Possible values: 1 , -1.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /acme/00000000-0000-0000-0000-000000000000/risks HTTP/1.1\n{\n\t\"assigned_roles\":[\n\t\t\"Job1\"\n\t],\n\t\"associated_activity\":\"\",\n\t\"category\":\"safety_fall\",\n\t\"comments\":[],\n\t\"consequence\":0,\n\t\"creator_role\":\"Job4\",\n\t\"desc\":\"Risk description that describes the risk\",\n\t\"element\":\"Doors\",\n\t\"level_of_risk\":0,\n\t\"likelihood\":0,\n\t\"location_desc\":\"Tower 3 - Level 2\",\n\t\"mitigation_desc\":\"Erect temporary barrier\",\n\t\"mitigation_detail\":\"Erect a temporary 1.5m metal barrier along edge\",\n\t\"mitigation_stage\":\"Construction stage 5\",\n\t\"mitigation_status\":\"proposed\",\n\t\"mitigation_type\":\"Eliminate\",\n\t\"name\":\"Risk 1\",\n\t\"overall_level_of_risk\":0,\n\t\"position\":[55000.0,80000.0,-10000.0],\n\t\"residual_consequence\":-1,\n\t\"residual_level_of_risk\":-1,\n\t\"residual_likelihood\":-1,\n\t\"residual_risk\":\"\",\n\t\"risk_factor\":\"Factor 9\",\n\t\"safetibase_id\":\"\",\n\t\"scope\":\"Tower 3\",\n\t\"viewpoint\":{\n\t\t\"aspect_ratio\":1.4,\n\t\t\"clippingPlanes\":[],\n\t\t\"far\":300000,\n\t\t\"fov\":1.05,\n\t\t\"hideIfc\":true,\n\t\t\"highlighted_group_id\":\"\",\n\t\t\"look_at\":[35000.0,40000.0,8000.0],\n\t\t\"near\":600.0,\n\t\t\"position\":[-70000.0,120000.0,150000.0],\n\t\t\"right\":[0.8,-0.3,0.6],\n\t\t\"up\":[0.3,0.9,-0.3],\n\t\t\"view_dir\":[0.5,-0.4,-0.7],\n\t\t\"screenshot\":\n\t}\n}", + "type": "post" + }, + { + "title": "Example usage:", + "content": "POST /acme/00000000-0000-0000-0000-000000000000/revision/00000000-0000-0000-0000-000000000001/risks HTTP/1.1\n{\n\t\"assigned_roles\":[\n\t\t\"Job1\"\n\t],\n\t\"associated_activity\":\"\",\n\t\"category\":\"safety_fall\",\n\t\"comments\":[],\n\t\"consequence\":0,\n\t\"creator_role\":\"Job4\",\n\t\"desc\":\"Risk description that describes the risk\",\n\t\"element\":\"Doors\",\n\t\"level_of_risk\":0,\n\t\"likelihood\":0,\n\t\"location_desc\":\"Tower 3 - Level 2\",\n\t\"mitigation_desc\":\"Erect temporary barrier\",\n\t\"mitigation_detail\":\"Erect a temporary 1.5m metal barrier along edge\",\n\t\"mitigation_stage\":\"Construction stage 5\",\n\t\"mitigation_status\":\"proposed\",\n\t\"mitigation_type\":\"Eliminate\",\n\t\"name\":\"Risk 1\",\n\t\"overall_level_of_risk\":0,\n\t\"position\":[55000.0,80000.0,-10000.0],\n\t\"residual_consequence\":-1,\n\t\"residual_level_of_risk\":-1,\n\t\"residual_likelihood\":-1,\n\t\"residual_risk\":\"\",\n\t\"risk_factor\":\"Factor 9\",\n\t\"safetibase_id\":\"\",\n\t\"scope\":\"Tower 3\",\n\t\"viewpoint\":{\n\t\t\"aspect_ratio\":1.4,\n\t\t\"clippingPlanes\":[],\n\t\t\"far\":300000,\n\t\t\"fov\":1.05,\n\t\t\"hideIfc\":true,\n\t\t\"highlighted_group_id\":\"\",\n\t\t\"look_at\":[35000.0,40000.0,8000.0],\n\t\t\"near\":600.0,\n\t\t\"position\":[-70000.0,120000.0,150000.0],\n\t\t\"right\":[0.8,-0.3,0.6],\n\t\t\"up\":[0.3,0.9,-0.3],\n\t\t\"view_dir\":[0.5,-0.4,-0.7],\n\t\t\"screenshot\":\n\t}\n}", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"_id\":\"00000000-0000-0000-0000-000000000002\",\n\t\"account\":\"acme\",\n\t\"assigned_roles\":[\n\t\t\"Job1\"\n\t],\n\t\"associated_activity\":\"\",\n\t\"category\":\"safety_fall\",\n\t\"comments\":[],\n\t\"consequence\":0,\n\t\"created\":1567156228976,\n\t\"creator_role\":\"Job4\",\n\t\"desc\":\"Risk description that describes the risk\",\n\t\"element\":\"Doors\",\n\t\"level_of_risk\":0,\n\t\"likelihood\":0,\n\t\"location_desc\":\"Tower 3 - Level 2\",\n\t\"mitigation_desc\":\"Erect temporary barrier\",\n\t\"mitigation_detail\":\"Erect a temporary 1.5m metal barrier along edge\",\n\t\"mitigation_stage\":\"Construction stage 5\",\n\t\"mitigation_status\":\"proposed\",\n\t\"mitigation_type\":\"Eliminate\",\n\t\"model\":\"00000000-0000-0000-0000-000000000000\",\n\t\"name\":\"Risk 1\",\n\t\"overall_level_of_risk\":0,\n\t\"owner\":\"alice\",\n\t\"position\":[55000.0,80000.0,-10000.0],\n\t\"residual_consequence\":-1,\n\t\"residual_level_of_risk\":-1,\n\t\"residual_likelihood\":-1,\n\t\"residual_risk\":\"\",\n\t\"rev_id\":\"00000000-0000-0000-0000-000000000001\",\n\t\"risk_factor\":\"Factor 9\",\n\t\"safetibase_id\":\"\",\n\t\"scope\":\"Tower 3\",\n\t\"thumbnail\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/thumbnail.png\",\n\t\"viewpoint\":{\n\t\t\"aspect_ratio\":1.4,\n\t\t\"clippingPlanes\":[],\n\t\t\"far\":300000,\n\t\t\"fov\":1.05,\n\t\t\"guid\":\"00000000-0000-0000-0000-000000000004\",\n\t\t\"hideIfc\":true,\n\t\t\"look_at\":[35000.0,40000.0,8000.0],\n\t\t\"near\":600.0,\n\t\t\"position\":[-70000.0,120000.0,150000.0],\n\t\t\"right\":[0.8,-0.3,0.6],\n\t\t\"screenshot\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/viewpoints/00000000-0000-0000-0000-000000000003/screenshot.png\",\n\t\t\"screenshotSmall\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/viewpoints/00000000-0000-0000-0000-000000000003/screenshotSmall.png\",\n\t\t\"up\":[0.3,0.9,-0.3],\n\t\t\"view_dir\":[0.5,-0.4,-0.7]\n\t}\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/risk.js", + "groupTitle": "SafetiBase Risks" + }, + { + "type": "patch", + "url": "/:teamspace/:model[/revision/:revId]/risks/:riskId", + "title": "Update risk", + "name": "updateRisk", + "group": "Risks", + "description": "

Update model risk.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "revId", + "description": "

Revision ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "riskId", + "description": "

Risk ID

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "name", + "description": "

Risk name

" + }, + { + "group": "Request body", + "type": "String[]", + "optional": false, + "field": "assigned_roles", + "description": "

Risk owner

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "associated_activity", + "description": "

Associated activity

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "category", + "description": "

Category

" + }, + { + "group": "Request body", + "type": "Number", + "optional": false, + "field": "consequence", + "description": "

Risk consequence (0: very low, 1: low, 2: moderate, 3: high, 4: very high)

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "desc", + "description": "

Risk description

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "element", + "description": "

Element type

" + }, + { + "group": "Request body", + "type": "Number", + "optional": false, + "field": "likelihood", + "description": "

Risk likelihood (0: very low, 1: low, 2: moderate, 3: high, 4: very high)

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "location_desc", + "description": "

Location description

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "mitigation_status", + "description": "

Treatment status

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "mitigation_desc", + "description": "

Treatment summary

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "mitigation_detail", + "description": "

Treatment detailed description

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "mitigation_stage", + "description": "

Treatment stage

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "mitigation_type", + "description": "

Treatment type

" + }, + { + "group": "Request body", + "type": "Number[3]", + "optional": false, + "field": "position", + "description": "

Risk pin coordinates

" + }, + { + "group": "Request body", + "type": "Number", + "optional": false, + "field": "residual_consequence", + "description": "

Treated risk consequence (-1: unset, 0: very low, 1: low, 2: moderate, 3: high, 4: very high)

" + }, + { + "group": "Request body", + "type": "Number", + "optional": false, + "field": "residual_likelihood", + "description": "

Treated risk likelihood (-1: unset, 0: very low, 1: low, 2: moderate, 3: high, 4: very high)

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "residual_risk", + "description": "

Residual risk

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "risk_factor", + "description": "

Risk factor

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "scope", + "description": "

Construction scope

" + }, + { + "group": "Request body", + "type": "Viewpoint", + "optional": false, + "field": "viewpoint", + "description": "

Viewpoint

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "PATCH /acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002 HTTP/1.1\n{\n\t\"residual_likelihood\":1\n}", + "type": "patch" + }, + { + "title": "Example usage:", + "content": "PATCH /acme/00000000-0000-0000-0000-000000000000/revision/00000000-0000-0000-0000-000000000001/risks/00000000-0000-0000-0000-000000000002 HTTP/1.1\n{\n\t\"residual_likelihood\":1\n}", + "type": "patch" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"_id\":\"00000000-0000-0000-0000-000000000002\",\n\t\"account\":\"acme\",\n\t\"assigned_roles\":[\n\t\t\"Job1\"\n\t],\n\t\"associated_activity\":\"\",\n\t\"category\":\"safety_fall\",\n\t\"comments\":[],\n\t\"consequence\":0,\n\t\"created\":1567156228976,\n\t\"creator_role\":\"Job4\",\n\t\"desc\":\"Risk description that describes the risk\",\n\t\"element\":\"Doors\",\n\t\"level_of_risk\":0,\n\t\"likelihood\":0,\n\t\"location_desc\":\"Tower 3 - Level 2\",\n\t\"mitigation_desc\":\"Erect temporary barrier\",\n\t\"mitigation_detail\":\"Erect a temporary 1.5m metal barrier along edge\",\n\t\"mitigation_stage\":\"Construction stage 5\",\n\t\"mitigation_status\":\"proposed\",\n\t\"mitigation_type\":\"Eliminate\",\n\t\"model\":\"00000000-0000-0000-0000-000000000000\",\n\t\"name\":\"Risk 1\",\n\t\"owner\":\"alice\",\n\t\"overall_level_of_risk\":0,\n\t\"position\":[55000.0,80000.0,-10000.0],\n\t\"residual_consequence\":-1,\n\t\"residual_level_of_risk\":-1,\n\t\"residual_likelihood\":1,\n\t\"residual_risk\":\"\",\n\t\"rev_id\":\"00000000-0000-0000-0000-000000000001\",\n\t\"risk_factor\":\"Factor 9\",\n\t\"safetibase_id\":\"\",\n\t\"scope\":\"Tower 3\",\n\t\"thumbnail\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/thumbnail.png\",\n\t\"viewpoint\":{\n\t\t\"aspect_ratio\":1.4,\n\t\t\"clippingPlanes\":[],\n\t\t\"far\":300000,\n\t\t\"fov\":1.05,\n\t\t\"guid\":\"00000000-0000-0000-0000-000000000004\",\n\t\t\"hideIfc\":true,\n\t\t\"look_at\":[35000.0,40000.0,8000.0],\n\t\t\"near\":600.0,\n\t\t\"position\":[-70000.0,120000.0,150000.0],\n\t\t\"right\":[0.8,-0.3,0.6],\n\t\t\"screenshot\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/viewpoints/00000000-0000-0000-0000-000000000003/screenshot.png\",\n\t\t\"screenshotSmall\":\"acme/00000000-0000-0000-0000-000000000000/risks/00000000-0000-0000-0000-000000000002/viewpoints/00000000-0000-0000-0000-000000000003/screenshotSmall.png\",\n\t\t\"up\":[0.3,0.9,-0.3],\n\t\t\"view_dir\":[0.5,-0.4,-0.7]\n\t}\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/risk.js", + "groupTitle": "SafetiBase Risks" + }, + { + "type": "post", + "url": "/:teamspace/:model/sequences", + "title": "Create custom sequence", + "name": "createSequence", + "group": "Sequences", + "description": "

Create custom sequence for model.

", + "examples": [ + { + "title": "Example usage", + "content": "POST /acme/00000000-0000-0000-0000-000000000000/sequences HTTP/1.1\n{\n\t\"name\":\"Custom Sequence 1\",\n\t\"frames\":[\n\t\t{\n\t\t\t\"dateTime\":1244246400000,\n\t\t\t\"viewpoint\":{\n\t\t\t\t\"override_groups\":[\n\t\t\t\t\t{\n\t\t\t\t\t\t\"color\":[\n\t\t\t\t\t\t\t0,\n\t\t\t\t\t\t\t255,\n\t\t\t\t\t\t\t0\n\t\t\t\t\t\t],\n\t\t\t\t\t\t\"rules\":[\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"field\":\"IFC GUID\",\n\t\t\t\t\t\t\t\t\"operator\":\"IS\",\n\t\t\t\t\t\t\t\t\"values\":[\n\t\t\t\t\t\t\t\t\t\"0h79Q0rcfC1gOPK50yoFCv\",\n\t\t\t\t\t\t\t\t\t\"0K5o7g755EZw2RjNI7HcYK\",\n\t\t\t\t\t\t\t\t\t\"0yuGDtpaPCSBT7QB7wvN5I\",\n\t\t\t\t\t\t\t\t\t\"2HBVtaIWv07ud53r01WB6q\"\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t],\n\t\t\t\t\t\t\"account\":\"acme\",\n\t\t\t\t\t\t\"model\":\"00000000-0000-0000-0000-000000000000\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"hidden_group\":{\n\t\t\t\t\t\"rules\":[\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"field\":\"IFC GUID\",\n\t\t\t\t\t\t\t\"operator\":\"IS\",\n\t\t\t\t\t\t\t\"values\":[\n\t\t\t\t\t\t\t\t\"2S2omCydz5b9jSgrcLLblk\",\n\t\t\t\t\t\t\t\t\"0_U7q0Dzj6DfPp4VzMmTUt\",\n\t\t\t\t\t\t\t\t\"0iMv$JxRL67v6DoyA3RRwz\",\n\t\t\t\t\t\t\t\t\"1W4yiIKW92qAUdezi70DTY\",\n\t\t\t\t\t\t\t\t\"00ojKm$5f7luRCAjta0hsu\",\n\t\t\t\t\t\t\t\t\"0d2LnELub06glJ9mZh2up$\",\n\t\t\t\t\t\t\t\t\"37gui3POjDQgmIadjhr$ek\",\n\t\t\t\t\t\t\t\t\"3XAjSwznb6PfZG9t_wAFXi\"\n\t\t\t\t\t\t\t]\n\t\t\t\t\t\t}\n\t\t\t\t\t],\n\t\t\t\t\t\"account\":\"acme\",\n\t\t\t\t\t\"model\":\"00000000-0000-0000-0000-000000000000\"\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"dateTime\":1244246500000,\n\t\t\t\"viewpoint\":{\n\t\t\t\t\"up\":[0,1,0],\n\t\t\t\t\"position\":[38,38 ,125.080119148101],\n\t\t\t\t\"look_at\":[0,0,-163.080119148101],\n\t\t\t\t\"view_dir\":[0,0,-1],\n\t\t\t\t\"right\":[1,0,0],\n\t\t\t\t\"fov\":2.11248306530104,\n\t\t\t\t\"aspect_ratio\":0.875018933732738,\n\t\t\t\t\"far\":276.756120771945,\n\t\t\t\t\"near\":76.4241101223321\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"dateTime\":1244246700000,\n\t\t\t\"viewpoint\":{\n\t\t\t\t\"override_groups\":[\n\t\t\t\t\t{\n\t\t\t\t\t\t\"color\":[\n\t\t\t\t\t\t\t0,\n\t\t\t\t\t\t\t255,\n\t\t\t\t\t\t\t0\n\t\t\t\t\t\t],\n\t\t\t\t\t\t\"rules\":[\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"field\":\"IFC GUID\",\n\t\t\t\t\t\t\t\t\"operator\":\"IS\",\n\t\t\t\t\t\t\t\t\"values\":[\n\t\t\t\t\t\t\t\t\t\"00ojKm$5f7luRCAjta0hsu\"\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t],\n\t\t\t\t\t\t\"account\":\"acme\",\n\t\t\t\t\t\t\"model\":\"00000000-0000-0000-0000-000000000000\"\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"dateTime\":1244419200000,\n\t\t\t\"viewId\":\"00000000-0000-0001-0001-000000000001\"\n\t\t},\n\t\t{\n\t\t\t\"dateTime\":1244458200000,\n\t\t\t\"viewId\":\"00000000-0000-0001-0001-000000000002\"\n\t\t},\n\t\t{\n\t\t\t\"dateTime\":1244484300000,\n\t\t\t\"viewpoint\": {}\n\t\t}\n\t]\n}", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"_id\":\"00000000-0000-0000-0000-000000000002\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + } + }, + { + "type": "post", + "url": "/:teamspace/:model/sequences/:sequenceId/activities", + "title": "Create one or more activities", + "name": "createSequenceActivities", + "group": "Sequences", + "description": "

Creates a sequence activity tree.

", + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "Activity[]", + "optional": false, + "field": "activity", + "description": "

An array of the activity tree that will be created

" + }, + { + "group": "Request body", + "type": "Boolean", + "optional": true, + "field": "overwrite", + "description": "

This flag indicates whether the request will replace the currently stored activities or just added at the end of the currently stored activities array. If not present it will be considered as false.

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "sequenceId", + "description": "

Sequence unique ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Type: Activity": [ + { + "group": "Type: Activity", + "type": "String", + "optional": false, + "field": "name", + "description": "

The name of the activity

" + }, + { + "group": "Type: Activity", + "type": "Number", + "optional": false, + "field": "startDate", + "description": "

The starting timestamp date of the activity

" + }, + { + "group": "Type: Activity", + "type": "Number", + "optional": false, + "field": "endDate", + "description": "

The ending timestamp date of the activity

" + }, + { + "group": "Type: Activity", + "type": "Object", + "optional": true, + "field": "resources", + "description": "

The resources asoociated with the activity

" + }, + { + "group": "Type: Activity", + "type": "KeyValue[]", + "optional": true, + "field": "data", + "description": "

An array of key value pairs with metadata for the activity

" + }, + { + "group": "Type: Activity", + "type": "Activity[]", + "optional": true, + "field": "subActivities", + "description": "

An array of activities that will be children of the activity

" + } + ], + "Type: KeyValue": [ + { + "group": "Type: KeyValue", + "type": "String", + "optional": false, + "field": "key", + "description": "

The key of the pair

" + }, + { + "group": "Type: KeyValue", + "type": "Any", + "optional": false, + "field": "value", + "description": "

The value of the pair

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage", + "content": "POST /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0001-000000000001/activities HTTP/1.1\n{\n \"overwrite\": true,\n \"activities\": [\n {\n \"name\": \"Clinic Construction\",\n \"startDate\": 1603184400000,\n \"endDate\": 1613062800000,\n \"data\": [\n {\n \"key\": \"Color\",\n \"value\": \"green\"\n }\n ],\n \"subActivities\": [\n {\n \"name\": \"Site Work & Logistics\",\n \"startDate\": 1603184400000,\n \"endDate\": 1613062800000,\n \"data\": [\n {\n \"key\": \"Height\",\n \"value\": 12\n }\n ],\n \"subActivities\": [\n {\n \"name\": \"Site Office Installation\",\n \"startDate\": 1603184400000,\n \"endDate\": 1603213200000,\n \"data\": [\n {\n \"key\": \"Size\",\n \"value\": \"Big\"\n }\n ]\n },\n {\n \"name\": \"Excavation\",\n \"startDate\": 1603270800000,\n \"endDate\": 1603299600000\n }\n ]\n }\n ]\n }\n ]\n}", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences" + }, + { + "type": "delete", + "url": "/:teamspace/:model/sequences/:sequenceID/legend", + "title": "Delete legend", + "name": "deleteLegend", + "group": "Sequences", + "description": "

Delete the legend associated to this sequence

", + "examples": [ + { + "title": "Example usage", + "content": "DELETE /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0000-000000000002/legend HTTP/1.1", + "type": "delete" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + } + }, + { + "type": "delete", + "url": "/:teamspace/:model/sequences/:sequenceID", + "title": "Delete sequence", + "name": "deleteSequence", + "group": "Sequences", + "description": "

Delete the custom sequence by ID

", + "examples": [ + { + "title": "Example usage", + "content": "DELETE /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0000-000000000002 HTTP/1.1", + "type": "delete" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + } + }, + { + "type": "delete", + "url": "/:teamspace/:model/sequences/:sequenceId/activities/:activityId", + "title": "Edit an activity", + "name": "deleteSequenceActivity", + "group": "Sequences", + "description": "

Delete a sequence activity.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "sequenceId", + "description": "

Sequence unique ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "activityId", + "description": "

The activity unique ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage", + "content": "DELETE /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0001-000000000001/activities/fe94be44-5cd8-4aaf-b020-afc1456680d3 HTTP/1.1", + "type": "delete" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences" + }, + { + "type": "put", + "url": "/:teamspace/:model/sequences/:sequenceId/activities/:activityId", + "title": "Edit an activity", + "name": "editSequenceActivity", + "group": "Sequences", + "description": "

Edits a sequence activity.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "sequenceId", + "description": "

Sequence unique ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "activityId", + "description": "

The activity unique ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "name", + "description": "

The name of the activity

" + }, + { + "group": "Request body", + "type": "Number", + "optional": true, + "field": "startDate", + "description": "

The starting timestamp date of the activity

" + }, + { + "group": "Request body", + "type": "Number", + "optional": true, + "field": "endDate", + "description": "

The ending timestamp date of the activity

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "parent", + "description": "

The parent id if it has one. This parent must exist previously

" + }, + { + "group": "Request body", + "type": "Object", + "optional": true, + "field": "resources", + "description": "

The resources asoociated with the activity

" + }, + { + "group": "Request body", + "type": "KeyValue[]", + "optional": true, + "field": "data", + "description": "

An array of key value pairs with metadata for the activity

" + } + ], + "Type: KeyValue": [ + { + "group": "Type: KeyValue", + "type": "String", + "optional": false, + "field": "key", + "description": "

The key of the pair

" + }, + { + "group": "Type: KeyValue", + "type": "Any", + "optional": false, + "field": "value", + "description": "

The value of the pair

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage", + "content": "PATCH /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0001-000000000001/activities/fe94be44-5cd8-4aaf-b020-afc1456680d3 HTTP/1.1\n{\n \"name\":\"Renamed activity\"\n}", + "type": "patch" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences" + }, + { + "type": "get", + "url": "/:teamspace/:model/sequences/:sequenceID/legend", + "title": "get the legend", + "name": "getLegend", + "group": "Sequences", + "description": "

Get the legend for this sequence

", + "examples": [ + { + "title": "Example usage", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0000-000000000002/legend HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t \"Building works\": \"#aabbcc\"\n\t \"Temporary works\": \"#ffffff66\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/sequences/:sequenceID", + "title": "Get sequence", + "name": "getSequence", + "group": "Sequences", + "description": "

Get sequence by ID

", + "examples": [ + { + "title": "GET /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0000-000000000002 HTTP/1.1", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0000-000000000002 HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"teamspace\":\"alice\",\n\t\"model\":\"00000000-0000-0000-0000-000000000000\",\n\t\"rev_id\":\"00000000-0000-0000-0000-000000000001\",\n\t\"name\":\"Sequence 1\",\n\t\"frames\":[\n\t\t{\n\t\t\t\"dateTime\":1244246400000,\n\t\t\t\"state\":\"00000000-0000-0000-0001-000000000002\"\n\t\t},\n\t\t{\n\t\t\t\"dateTime\":1244419200000,\n\t\t\t\"state\":\"00000000-0000-0000-0002-000000000002\"\n\t\t}\n\t],\n\t\"_id\":\"00000000-0000-0000-0000-000000000002\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/:model/sequences/:sequenceId/activities", + "title": "Get all activities", + "name": "getSequenceActivities", + "group": "Sequences", + "description": "

Get all sequence activities.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "sequenceId", + "description": "

Sequence unique ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0001-000000000001/activities HTTP/1.1\n*", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"activities\":[\n\t\t{\n\t\t\t\"id\":\"00000000-0000-0001-0001-000000000001\",\n\t\t\t\"name\":\"Construction\",\n\t\t\t\"startDate\":1244246400000,\n\t\t\t\"endDate\":1244246450000,\n\t\t\t\"subActivities\":[\n\t\t\t\t{\n\t\t\t\t\t\"id\":\"00000000-0001-0001-0001-000000000001\",\n\t\t\t\t\t\"name\":\"Prepare site\",\n\t\t\t\t\t\"startDate\":1244246400000,\n\t\t\t\t\t\"endDate\":1244246430000,\n\t\t\t\t\t\"subActivities\":[\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"id\":\"00000001-0001-0001-0001-000000000001\",\n\t\t\t\t\t\t\t\"name\":\"Erect site hoarding\",\n\t\t\t\t\t\t\t\"startDate\":1244246400000,\n\t\t\t\t\t\t\t\"endDate\":1244246410000\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"id\":\"00000002-0001-0001-0001-000000000001\",\n\t\t\t\t\t\t\t\"name\":\"Clear existing structures\",\n\t\t\t\t\t\t\t\"startDate\":1244246410000,\n\t\t\t\t\t\t\t\"endDate\":1244246420000\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"id\":\"00000003-0001-0001-0001-000000000001\",\n\t\t\t\t\t\t\t\"name\":\"Smooth work surfaces\",\n\t\t\t\t\t\t\t\"startDate\":1244246420000,\n\t\t\t\t\t\t\t\"endDate\":1244246430000\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"id\":\"00000001-0002-0001-0001-000000000001\",\n\t\t\t\t\t\"name\":\"Construct tunnel\",\n\t\t\t\t\t\"startDate\":1244246430000,\n\t\t\t\t\t\"endDate\":1244246450000,\n\t\t\t\t\t\"subActivities\":[\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"id\":\"00000001-0002-0001-0001-000000000001\",\n\t\t\t\t\t\t\t\"name\":\"Deploy instant tunnel\",\n\t\t\t\t\t\t\t\"startDate\":1244246430000,\n\t\t\t\t\t\t\t\"endDate\":1244246440000\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"id\":\"00000002-0002-0001-0001-000000000001\",\n\t\t\t\t\t\t\t\"name\":\"Add road markings\",\n\t\t\t\t\t\t\t\"startDate\":1244246440000,\n\t\t\t\t\t\t\t\"endDate\":1244246450000\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences" + }, + { + "type": "get", + "url": "/:teamspace/:model/sequences/:sequenceId/activities/:activityId", + "title": "Get activity", + "name": "getSequenceActivityDetail", + "group": "Sequences", + "description": "

Get sequence activity details.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "sequenceId", + "description": "

Sequence ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "activityId", + "description": "

Activity ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0001-000000000001/activities/00000000-0000-0002-0001-000000000001 HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n \"id\":\"00000000-0000-0002-0001-000000000001\",\n \"name\":\"Construct tunnel\",\n \"sequenceId\": \"00000000-0000-0000-0001-000000000001\",\n \"parent\": \"00000130-2300-0002-0001-000567000001\"\n \"startDate\": 1610000000000,\n \"endDate\": 1615483938124,\n \"data\":[\n {\"key\":\"Name\",\"value\":\"Construction\"},\n {\"key\":\"Status\",\"value\":\"Planned\"},\n {\"key\":\"Is Compound Task\",\"value\":\"Yes\"},\n {\"key\":\"Code\",\"value\":\"ST00020\"},\n {\"key\":\"Planned Start\",\"value\":\"15 Apr 2020 10:00:00\"},\n {\"key\":\"Type\",\"value\":\"Work\"},\n {\"key\":\"Constraint\",\"value\":\"No Constraint\"},\n {\"key\":\"Planned Finish\",\"value\":\"11 Sep 2020 18:00:00\"},\n {\"key\":\"Percentage Complete\",\"value\":0},\n {\"key\":\"Physical Volume Unity\",\"value\":\"Unknown\"},\n {\"key\":\"Estimated Rate\",\"value\":0},\n {\"key\":\"Planned Physical Volume\",\"value\":6.6},\n {\"key\":\"Actual Physical Volume\",\"value\":0.9},\n {\"key\":\"Remaining Physical Volume\",\"value\":5.7},\n {\"key\":\"Budgeted Cost\",\"value\":30},\n {\"key\":\"Actual Cost\",\"value\":9999.99}\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences" + }, + { + "type": "get", + "url": "/:teamspace/:model/sequences/:sequenceId/state/:stateId", + "title": "Get state", + "name": "getSequenceState", + "group": "Sequences", + "description": "

Get state of model in sequence.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "sequenceId", + "description": "

Sequence unique ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "stateId", + "description": "

State unique ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0001-000000000001/state/00000000-0000-0000-0001-000000000002 HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"transparency\":[\n\t\t{\n\t\t\t\"value\":1,\n\t\t\t\"shared_ids\":[\n\t\t\t\t11111111-1111-1111-1111-111111111111,\n\t\t\t\t22222222-2222-2222-2222-222222222222,\n\t\t\t\t33333333-3333-3333-3333-333333333333\n\t\t\t]\n\t\t}\n\t],\n\t\"color\":[\n\t\t{\n\t\t\t\"value\":[\n\t\t\t\t0,\n\t\t\t\t1,\n\t\t\t\t0\n\t\t\t],\n\t\t\t\"shared_ids\":[\n\t\t\t\t44444444-4444-4444-4444-444444444444,\n\t\t\t\t55555555-5555-5555-5555-555555555555,\n\t\t\t\t66666666-6666-6666-6666-666666666666\n\t\t\t]\n\t\t}\n\t],\n\t\"transform\":[\n\t\t{\n\t\t\t\"value\":[\n\t\t\t\t1, 0, 0, -0.0036411285400390625,\n\t\t\t\t0, 1, 0, 0.0012891292572021484,\n\t\t\t\t0, 0, 1, 0,\n\t\t\t\t0, 0, 0, 1\n\t\t\t],\n\t\t\t\"shared_ids\":[\n\t\t\t\t77777777-7777-7777-7777-777777777777,\n\t\t\t\t88888888-8888-8888-8888-888888888888,\n\t\t\t\t99999999-9999-9999-9999-999999999999\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"value\":[\n\t\t\t\t1, 0, 0, -0.0036411285400390625,\n\t\t\t\t0, 1, 0, 0.0012891292572021484,\n\t\t\t\t0, 0, 1, 0,\n\t\t\t\t0, 0, 0, 1\n\t\t\t],\n\t\t\t\"shared_ids\":[\n\t\t\t\t66666666-6666-6666-6666-666666666666\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"value\":[\n\t\t\t\t1, 0, 0, -0.0036411285400390625,\n\t\t\t\t0, 1, 0, 0.0012891292572021484,\n\t\t\t\t0, 0, 1, 0,\n\t\t\t\t0, 0, 0, 1\n\t\t\t],\n\t\t\t\"shared_ids\":[\n\t\t\t\t44444444-4444-4444-4444-444444444444,\n\t\t\t\taaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa,\n\t\t\t\tbbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb,\n\t\t\t\tcccccccc-cccc-cccc-cccc-cccccccccccc\n\t\t\t]\n\t\t}\n\t]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences" + }, + { + "type": "get", + "url": "/:teamspace/:model/sequences", + "title": "List all sequences", + "name": "listSequences", + "group": "Sequences", + "description": "

List all sequences associated with the model.

", + "parameter": { + "fields": { + "Query": [ + { + "group": "Query", + "type": "String", + "optional": true, + "field": "rev_id", + "description": "

Revision unique ID

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/sequences HTTP/1.1", + "type": "get" + }, + { + "title": "Example usage (with revision)", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/sequences?rev_id=00000000-0000-0000-0000-000000000001 HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"teamspace\":\"alice\",\n\t\t\"model\":\"00000000-0000-0000-0000-000000000000\",\n\t\t\"rev_id\":\"00000000-0000-0000-0000-000000000001\",\n\t\t\"name\":\"Sequence 1\",\n\t\t\"frames\":[\n\t\t\t{\n\t\t\t\t\"dateTime\":1244246400000,\n\t\t\t\t\"state\":\"00000000-0000-0000-0001-000000000002\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"dateTime\":1244419200000,\n\t\t\t\t\"state\":\"00000000-0000-0000-0002-000000000002\"\n\t\t\t}\n\t\t],\n\t\t\"_id\":\"00000000-0000-0000-0000-000000000002\"\n\t}\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences" + }, + { + "type": "put", + "url": "/:teamspace/:model/sequences/:sequenceID/legend", + "title": "Add/Update legend", + "name": "updateLegend", + "group": "Sequences", + "description": "

Update/add a legend to this sequence

", + "examples": [ + { + "title": "Example usage", + "content": "PUT /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0000-000000000002/legend HTTP/1.1", + "type": "put" + }, + { + "title": "Example usage:", + "content": "{\n\t \"Building works\": \"#aabbcc\"\n\t \"Temporary works\": \"#ffffff66\"\n}", + "type": "put" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + } + }, + { + "type": "patch", + "url": "/:teamspace/:model/sequences/:sequenceID", + "title": "Update a sequence", + "name": "updateSequence", + "group": "Sequences", + "description": "

Update a sequence (note: currently only name chance is supported

", + "examples": [ + { + "title": "Example usage", + "content": "PATCH /acme/00000000-0000-0000-0000-000000000000/sequences/00000000-0000-0000-0000-000000000002 HTTP/1.1", + "type": "patch" + }, + { + "title": "Example usage:", + "content": "{\n\t \"name\": \"Building works\"\n}", + "type": "patch" + } + ], + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "name", + "description": "

The new name of the sequence

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/sequence.js", + "groupTitle": "Sequences" + }, + { + "type": "get", + "url": "/:teamspace/subscriptions", + "title": "List subscriptions", + "name": "listSubscriptions", + "group": "Subscription", + "description": "

List all subscriptions for current user if applicable.

", + "permission": [ + { + "name": "teamSpaceAdmin" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/subscriptions HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n basic: {\n collaborators: 0,\n data: 200\n },\n discretionary: {\n collaborators: \"unlimited\",\n data: 10240,\n expiryDate: null\n }\n}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "401": [ + { + "group": "401", + "optional": false, + "field": "NOT_AUTHORIZED", + "description": "

Not Authorized

" + } + ] + }, + "examples": [ + { + "title": "Error-Response", + "content": "HTTP/1.1 401 Not Authorized\n{\n\t\"message\":\"Not Authorized\",\n\t\"status\":401,\"code\":\n\t\"NOT_AUTHORIZED\",\n\t\"value\":9,\n\t\"place\":\"GET /teamSpace1/subscriptions\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/subscriptions.js", + "groupTitle": "Subscription" + }, + { + "type": "post", + "url": "/:teamspace/members", + "title": "Add a team member", + "name": "addTeamMember", + "group": "Teamspace", + "description": "

Adds a user to a teamspace and assign it a job.

", + "permission": [ + { + "name": "teamSpaceAdmin" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "job", + "description": "

The job that the users going to have assigned

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "user", + "description": "

The username of the user to become a member

" + }, + { + "group": "Request body", + "type": "String[]", + "optional": false, + "field": "permissions", + "description": "

The permisions to be assigned to the member it can be an empty array or have a "teamspace_admin" value.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /teamSpace1/members HTTP/1.1\n{\n job: \"jobA\",\n user: \"projectshared\",\n permissions: []\n}", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success", + "content": "{\n job: \"jobA\",\n permissions: [],\n user: \"projectshared\",\n firstName: \"Drink\",\n lastName: \"Coffee\",\n company: null\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/teamspace.js", + "groupTitle": "Teamspace" + }, + { + "type": "get", + "url": "/:teamspace/members/search/:searchString", + "title": "Search for non-members", + "name": "findUsersWithoutMembership", + "group": "Teamspace", + "description": "

It returns a list of users that dont belong to the teamspace and that their usernames matches partially with the string and if entered an email it only matches if the string is the entire email address.

In the result it's included their username, first name, last name, company and roles in other teamspaces.

", + "permission": [ + { + "name": "teamSpaceAdmin" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "search", + "description": "

Search string provided to find member

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/members/search/project HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success", + "content": "HTTP/1.1 200 OK\n\n[\n {\n user: \"projectowner\",\n roles: [\n {\n role: \"team_member\",\n db: \"projectowner\"\n }\n ],\n firstName: \"Project\",\n lastName: \"Owner\",\n company: null\n },\n {\n user: \"projectshared\",\n roles: [\n {\n role: \"team_member\",\n db: \"projectshared\"\n }\n ],\n firstName: \"Drink\",\n lastName: \"Coffee\",\n company: null\n },\n {\n user: \"project_username\",\n roles: [\n {\n role: \"team_member\",\n db: \"project_username\"\n }\n ],\n firstName: \"George\",\n lastName: \"Crown\",\n company: null\n },\n]", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/teamspace.js", + "groupTitle": "Teamspace" + }, + { + "type": "get", + "url": "/:teamspace/addOns", + "title": "get enabled add ons", + "name": "getAddOns", + "group": "Teamspace", + "description": "

view the list of addOns enabled on this teamspace

", + "permission": [ + { + "name": "teamspace member" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "success": { + "examples": [ + { + "title": "Success", + "content": "{\n vrEnabled: true,\n hereEnabled: true\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/teamspace.js", + "groupTitle": "Teamspace" + }, + { + "type": "get", + "url": "/:teamspace/billingInfo", + "title": "Get billing info", + "name": "getBillingInfo", + "group": "Teamspace", + "description": "

It returns the teamspace billing info.

", + "permission": [ + { + "name": "teamSpaceAdmin" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/billingInfo HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success", + "content": "HTTP/1.1 200 OK\n{\n vat: \"GB 365684514\",\n line1: \"10 Downing Street\",\n postalCode: \"SW1A 2AA\",\n city: \"London\",\n company: \"Teamspace one\",\n countryCode: \"GB\",\n lastName: \"Voorhees\",\n firstName: \"Jason\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/teamspace.js", + "groupTitle": "Teamspace" + }, + { + "type": "get", + "url": "/:teamspace/members/:user", + "title": "Get member's info", + "name": "getMemberInfo", + "group": "Teamspace", + "description": "

It returns the teamspace's member small info .

", + "permission": [ + { + "name": "teamSpaceMember" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user", + "description": "

The username of the user you wish to query

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/members/viewerTeamspace1Model1JobB HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success", + "content": "HTTP/1.1 200 OK\n{\n user: \"viewerTeamspace1Model1JobB\",\n firstName: \"Alice\",\n lastName: \"Stratford\",\n company: \"Teamspace one\",\n job: {\"_id\": \"Job1\", color: \"#FFFFFF\"}\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/teamspace.js", + "groupTitle": "Teamspace" + }, + { + "type": "get", + "url": "/:teamspace/members", + "title": "Get members list", + "name": "getMemberList", + "group": "Teamspace", + "description": "

It returns a list of members identifying which of them are teamspace administrators, and their jobs.

", + "permission": [ + { + "name": "teamSpaceMember" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/members HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success", + "content": "HTTP/1.1 200 OK\n{\n members: [\n {\n user: \"teamSpace1\",\n firstName: \"Teamspace\",\n lastName: \"One\",\n company: \"Teamspace one\",\n permissions: [\n \"teamspace_admin\"\n ],\n job: \"jobA\",\n isCurrentUser: true\n },\n {\n user: \"unassignedTeamspace1UserJobA\",\n firstName: \"John\",\n lastName: \"Williams\",\n company: \"Teamspace One\",\n permissions: [],\n job: \"jobA\",\n isCurrentUser: false\n },\n {\n user: \"viewerTeamspace1Model1JobB\",\n firstName: \"Alice\",\n lastName: \"Stratford\",\n company: \"Teamspace one\",\n permissions: [],\n job: \"jobB\",\n isCurrentUser: false\n }\n ]\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/teamspace.js", + "groupTitle": "Teamspace" + }, + { + "type": "get", + "url": "/:teamspace/settings/mitigations.csv", + "title": "Download mitigations file", + "name": "getMitigationsFile", + "group": "Teamspace", + "description": "

Returns a CSV file containing all defined suggested risk mitigations.

", + "examples": [ + { + "title": "Example usage", + "content": "GET /acme/settings/mitigations.csv HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/teamspace.js", + "groupTitle": "Teamspace", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + } + }, + { + "type": "get", + "url": "/:teamspace/quota", + "title": "Get Quota Information", + "name": "getQuotaInfo", + "group": "Teamspace", + "description": "

It returns the quota information. Each teamspace has a space limit and a limit of collaborators. The values returned are space used (both these values are in bytes) and the collaborator limit. If spaceLimit or collaboratorLimit are nulled it means that there are no space limit/member limit.

", + "permission": [ + { + "name": "teamSpaceAdmin" + } + ], + "examples": [ + { + "title": "Example usage:", + "content": "GET /teamSpace1/quota HTTP/1.1", + "type": "get" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "success": { + "examples": [ + { + "title": "Success", + "content": "HTTP/1.1 200 OK\n{\n spaceLimit: 1048576,\n\t collaboratorLimit: 12,\n spaceUsed: 2048\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/teamspace.js", + "groupTitle": "Teamspace" + }, + { + "type": "get", + "url": "/:teamspace/settings", + "title": "Get teamspace settings", + "name": "getTeamspaceSettings", + "group": "Teamspace", + "description": "

Returns all teamspace settings.

", + "examples": [ + { + "title": "Example usage", + "content": "GET /acme/settings HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"riskCategories\":[\n\t\t\"Commercial Issue\",\n\t\t\"Environmental Issue\",\n\t\t\"Health - Material effect\",\n\t\t\"Health - Mechanical effect\",\n\t\t\"Safety Issue - Fall\",\n\t\t\"Safety Issue - Trapped\",\n\t\t\"Safety Issue - Event\",\n\t\t\"Safety Issue - Handling\",\n\t\t\"Safety Issue - Struck\",\n\t\t\"Safety Issue - Public\",\n\t\t\"Social Issue\",\n\t\t\"Other Issue\",\n\t\t\"UNKNOWN\"\n\t],\n\t\"topicTypes\":[\n\t\t\"For information\",\n\t\t\"VR\",\n\t\t\"Clash\",\n\t\t\"Diff\",\n\t\t\"RFI\",\n\t\t\"Risk\",\n\t\t\"H&S\",\n\t\t\"Design\",\n\t\t\"Constructibility\",\n\t\t\"GIS\"\n\t],\n\t\"mitigationsUpdatedAt\":1567156228976,\n\t\"_id\":\"acme\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/teamspace.js", + "groupTitle": "Teamspace", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + } + }, + { + "type": "delete", + "url": "/:teamspace/members/:user", + "title": "Remove from the teamspace", + "name": "removeTeamMember", + "group": "Teamspace", + "description": "

Removes a user from the teampspace.

", + "permission": [ + { + "name": "teamSpaceAdmin" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user", + "description": "

Username of the member to remove

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "DELETE /teamSpace1/members/viewerTeamspace1Model1JobB HTTP/1.1", + "type": "delete" + } + ], + "success": { + "examples": [ + { + "title": "Success", + "content": "HTTP/1.1 200 OK\n{\n user: \"viewerTeamspace1Model1JobB\",\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/teamspace.js", + "groupTitle": "Teamspace" + }, + { + "type": "patch", + "url": "/:teamspace/settings", + "title": "Update teamspace settings", + "name": "updateTeamspaceSettings", + "group": "Teamspace", + "description": "

Update teamspace settings.

", + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "String[]", + "optional": true, + "field": "riskCategories", + "description": "

List of risk categories

" + }, + { + "group": "Request body", + "type": "String[]", + "optional": true, + "field": "topicTypes", + "description": "

List of issue topic types

" + } + ], + "Risk category": [ + { + "group": "Risk category", + "type": "String", + "optional": false, + "field": "value", + "description": "

Value of risk category

" + }, + { + "group": "Risk category", + "type": "String", + "optional": false, + "field": "label", + "description": "

Label for risk category

" + } + ], + "Topic type": [ + { + "group": "Topic type", + "type": "String", + "optional": false, + "field": "value", + "description": "

Value of topic type

" + }, + { + "group": "Topic type", + "type": "String", + "optional": false, + "field": "label", + "description": "

Label for topic type

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage", + "content": "PUT /acme/settings HTTP/1.1\n{\n\t\"topicTypes\":[\n\t\t\"New Topic 1\",\n\t\t\"New Topic 2\"\n\t],\n\t\"riskCategories\":[\n\t\t\"New Category 1\",\n\t\t\"NEW CATEGORY 2\"\n\t]\n}", + "type": "put" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"riskCategories\":[\n\t\t\"New Category 1\",\n\t\t\"NEW CATEGORY 2\"\n\t],\n\t\"topicTypes\":[\n\t\t\"New Topic 1\",\n\t\t\"New Topic 2\"\n\t],\n\t\"mitigationsUpdatedAt\":1567156228976,\n\t\"_id\":\"acme\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/teamspace.js", + "groupTitle": "Teamspace" + }, + { + "type": "post", + "url": "/:teamspace/settings/mitigations.csv", + "title": "Upload mitigations file", + "name": "uploadMitigationsFile", + "group": "Teamspace", + "description": "

Upload a risk mitigations CSV file to a teamspace.

", + "examples": [ + { + "title": "Example usage", + "content": "POST /acme/settings/mitigations.csv HTTP/1.1\n", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"status\":\"ok\"\n}", + "type": "json" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/teamspace.js", + "groupTitle": "Teamspace", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + } + ] + } + } + }, + { + "type": "get", + "url": "/starredMeta", + "title": "Gets the starred metadata tags for the logged user", + "description": "

This endpoint returns the starred metadata tags. You can manage the starred metadata in the frontend from BIM (i) icon in the viewer.

", + "success": { + "examples": [ + { + "title": "Success", + "content": "HTTP/1.1 200 OK\n[\n \"material\",\n \"color\",\n \"base offset\"\n]", + "type": "json" + } + ] + }, + "name": "GetStarredMetadataTags", + "group": "User", + "version": "0.0.0", + "filename": "src/v4/routes/user.js", + "groupTitle": "User" + }, + { + "type": "get", + "url": "/starredModels", + "title": "Gets the starred models for the logged user", + "name": "GetStarredModels", + "group": "User", + "version": "0.0.0", + "filename": "src/v4/routes/user.js", + "groupTitle": "User" + }, + { + "type": "put", + "url": "/starredMeta", + "title": "Replaces the whole starred metadata tags array for the logged user", + "name": "SetMetadataTags", + "group": "User", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "optional": true, + "field": "String", + "description": "

(Request body) An array of tags to be starred

" + } + ] + }, + "examples": [ + { + "title": "Input", + "content": " [\n \t\"material\",\n\t \t\"color\"\n\t ]", + "type": "json" + } + ] + }, + "success": { + "examples": [ + { + "title": "Success", + "content": " HTTP/1.1 200 OK\n\t {}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "Error 4xx": [ + { + "group": "Error 4xx", + "optional": false, + "field": "400", + "description": "

BadRequest The request was malformed

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/user.js", + "groupTitle": "User" + }, + { + "type": "put", + "url": "/starredModels", + "title": "Sets the whole starred models for the logged user", + "name": "SetStarredModels", + "group": "User", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "optional": true, + "field": "String", + "description": "

An array of models to be starred, belong to the teamspace

" + } + ] + }, + "examples": [ + { + "title": "Input", + "content": " {\n \t\"user1\": [\"c7d9184a-83d3-4ef0-975c-ba2ced888e79\"],\n \t\"user2\": [\"4d17e126-8238-432d-a421-93819373e21a\", \"0411e74a-0661-48f9-bf4f-8eabe4a673a0\"]\n\t }", + "type": "json" + } + ] + }, + "success": { + "examples": [ + { + "title": "Success", + "content": " HTTP/1.1 200 OK\n\t {}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "Error 4xx": [ + { + "group": "Error 4xx", + "optional": false, + "field": "400", + "description": "

BadRequest The request was malformed

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/user.js", + "groupTitle": "User" + }, + { + "type": "post", + "url": "/starredMeta", + "title": "Adds a starred metadata tag for the logged user", + "name": "StarMetadataTags", + "group": "User", + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "tag", + "description": "

The tag to be starred

" + } + ] + }, + "examples": [ + { + "title": "Input", + "content": "{\n \"tag\": \"material\"\n}", + "type": "json" + } + ] + }, + "success": { + "examples": [ + { + "title": "Success", + "content": " HTTP/1.1 200 OK\n\t {}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "Error 4xx": [ + { + "group": "Error 4xx", + "optional": false, + "field": "400", + "description": "

BadRequest The request was malformed

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/user.js", + "groupTitle": "User" + }, + { + "type": "post", + "url": "/starredModels", + "title": "Adds a starred models for the logged user", + "name": "StarModels", + "group": "User", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

teamspace where model resides

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

model ID to add

" + } + ] + }, + "examples": [ + { + "title": "Input", + "content": "{\n \"teamspace\": \"user1\",\n \"model\": \"c7d9184a-83d3-4ef0-975c-ba2ced888e79\"\n}", + "type": "json" + } + ] + }, + "success": { + "examples": [ + { + "title": "Success", + "content": " HTTP/1.1 200 OK\n\t {}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "Error 4xx": [ + { + "group": "Error 4xx", + "optional": false, + "field": "400", + "description": "

BadRequest The request was malformed

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/user.js", + "groupTitle": "User" + }, + { + "type": "delete", + "url": "/starredMeta", + "title": "removes a starred metadata tag for the logged user if the tag exists", + "name": "UnstarMetadataTags", + "group": "User", + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "tag", + "description": "

The tag to be starred

" + } + ] + }, + "examples": [ + { + "title": "Input", + "content": "{\n \"tag\": \"material\"\n}", + "type": "json" + } + ] + }, + "success": { + "examples": [ + { + "title": "Success", + "content": " HTTP/1.1 200 OK\n\t {}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "Error 4xx": [ + { + "group": "Error 4xx", + "optional": false, + "field": "400", + "description": "

BadRequest The request was malformed

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/user.js", + "groupTitle": "User" + }, + { + "type": "delete", + "url": "/starredModels", + "title": "removes a starred models for the logged user if the tag exists", + "name": "UnstarModels", + "group": "User", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

teamspace where model resides

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

model ID to remove

" + } + ] + }, + "examples": [ + { + "title": "Input", + "content": "{\n \"teamspace\": \"user1\",\n \"model\": \"c7d9184a-83d3-4ef0-975c-ba2ced888e79\"\n}", + "type": "json" + } + ] + }, + "success": { + "examples": [ + { + "title": "Success", + "content": " HTTP/1.1 200 OK\n\t {}", + "type": "json" + } + ] + }, + "error": { + "fields": { + "Error 4xx": [ + { + "group": "Error 4xx", + "optional": false, + "field": "400", + "description": "

BadRequest The request was malformed

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/user.js", + "groupTitle": "User" + }, + { + "type": "delete", + "url": "/apikey", + "title": "Deletes the current apikey for the logged user", + "name": "deleteApiKey_HTTP_1_1_200_OK___", + "group": "User", + "version": "0.0.0", + "filename": "src/v4/routes/user.js", + "groupTitle": "User" + }, + { + "type": "post", + "url": "/apikey", + "title": "Generates an apikey for the logged user", + "name": "generateApiKey", + "success": { + "examples": [ + { + "title": "Success", + "content": "HTTP/1.1 200 OK\n{\n apiKey:\"20f947a673dce5419ce187ca7998a68f\"\n}", + "type": "json" + } + ] + }, + "group": "User", + "version": "0.0.0", + "filename": "src/v4/routes/user.js", + "groupTitle": "User" + }, + { + "type": "get", + "url": "/me", + "title": "Gets the profile for the logged user", + "name": "getProfile", + "success": { + "examples": [ + { + "title": "Success", + "content": "HTTP/1.1 200 OK\n{\n username: \"jasonv\",\n firstName: \"Jason\",\n lastName: \"Voorhees\",\n email: \"jason@vorhees.com\",\n hasAvatar: true\n}", + "type": "json" + } + ] + }, + "group": "User", + "version": "0.0.0", + "filename": "src/v4/routes/user.js", + "groupTitle": "User" + }, + { + "type": "post", + "url": "/:teamspace/:model/viewpoints/", + "title": "Create view", + "name": "createView", + "group": "Views", + "description": "

Create a new view.

", + "parameter": { + "fields": { + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "name", + "description": "

Name of view

" + }, + { + "group": "Request body", + "type": "Viewpoint", + "optional": false, + "field": "viewpoint", + "description": "

Viewpoint

" + }, + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "screenshot", + "description": "

Screenshot

" + }, + { + "group": "Request body", + "type": "String", + "optional": true, + "field": "clippingPlanes", + "description": "

List of clipping planes

" + } + ], + "Request body: screenshot": [ + { + "group": "Request body: screenshot", + "type": "String", + "optional": false, + "field": "base64", + "description": "

Screenshot image in base64

" + } + ], + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "POST /acme/00000000-0000-0000-0000-000000000000/viewpoints HTTP/1.1\n{\n\t\"clippingPlanes\":[],\n\t\"name\":\"View 3\",\n\t\"screenshot\":{\n\t\t\"base64\":\n\t}\n\t\"viewpoint\":{\n\t\t\"aspect_ratio\":1.1715909242630005,\n\t\t\"far\":233419.5625,\n\t\t\"fov\":1.0471975803375244,\n\t\t\"highlighted_group_id\":\"\",\n\t\t\"look_at\":[34448.78125, 2989.078125, 17619.7265625],\n\t\t\"near\":466.839111328125,\n\t\t\"position\":[34448.78125, 163958.484375, 17620.015625],\n\t\t\"right\":[0.9999919533729553, -7.683411240577698e-9, 0.00400533527135849],\n\t\t\"up\":[0.00400533527135849, 0.0000017881393432617188, -0.9999920129776001],\n\t\t\"view_dir\":[-6.984919309616089e-10, -1, -0.0000017881393432617188]\n\t}\n}", + "type": "post" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"_id\":\"00000000-0000-0000-0000-000000000001\"\n}", + "type": "png" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/view.js", + "groupTitle": "Views" + }, + { + "type": "delete", + "url": "/:teamspace/:model/viewpoints/:viewId", + "title": "Delete view", + "name": "deleteView", + "group": "Views", + "description": "

Delete a view.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "viewId", + "description": "

View ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "DELETE /acme/00000000-0000-0000-0000-000000000000/viewpoints/00000000-0000-0000-0000-000000000000 HTTP/1.1", + "type": "delete" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"status\":\"success\"\n}", + "type": "png" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/view.js", + "groupTitle": "Views" + }, + { + "type": "get", + "url": "/:teamspace/:model/viewpoints/:viewId", + "title": "Get view", + "name": "findView", + "group": "Views", + "description": "

Retrieve a view.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "viewId", + "description": "

View ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Type: ResultViewpoint": [ + { + "group": "Type: ResultViewpoint", + "type": "Number[3]", + "optional": false, + "field": "right", + "description": "

The right vector of the viewpoint indicating the direction of right in relative coordinates.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number[3]", + "optional": false, + "field": "up", + "description": "

The up vector of the viewpoint indicating the direction of up in relative coordinates.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number[3]", + "optional": false, + "field": "position", + "description": "

The position vector indicates where in the world the viewpoint is positioned.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number[3]", + "optional": false, + "field": "look_at", + "description": "

The vector indicating where in the world the viewpoint is looking at.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number[3]", + "optional": false, + "field": "view_dir", + "description": "

The vector indicating where is the viewpoint is looking at in relative coordinates.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number", + "optional": false, + "field": "near", + "description": "

The vector indicating the near plane.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number", + "optional": false, + "field": "far", + "description": "

The vector indicating the far plane.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number", + "optional": false, + "field": "fov", + "description": "

The angle of the field of view.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number", + "optional": false, + "field": "aspect_ratio", + "description": "

The aspect ratio of the fustrum.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "ClippingPlane[]", + "optional": true, + "field": "clippingPlanes", + "description": "

the clipping planes associated with the viewpoint

" + }, + { + "group": "Type: ResultViewpoint", + "type": "String", + "optional": true, + "field": "highlighted_group_id", + "description": "

If the viewpoint is associated with one or more highlighted objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: ResultViewpoint", + "type": "String", + "optional": true, + "field": "hidden_group_id", + "description": "

If the viewpoint is associated with one or more hidden objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: ResultViewpoint", + "type": "String", + "optional": true, + "field": "shown_group_id", + "description": "

If the viewpoint is associated with one or more shown objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: ResultViewpoint", + "type": "String[]", + "optional": true, + "field": "override_group_ids", + "description": "

If the viewpoint has one or more objects with colour override this field has an array of groups ids with one group for each colour

" + }, + { + "group": "Type: ResultViewpoint", + "type": "String[]", + "optional": true, + "field": "transformation_group_ids", + "description": "

List of group IDs with transformations

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Boolean", + "optional": false, + "field": "hide_IFC", + "description": "

A flag to hide the IFC

" + }, + { + "group": "Type: ResultViewpoint", + "type": "String", + "optional": false, + "field": "screenshot", + "description": "

A string in base64 representing the screenshot associated with the viewpoint

" + } + ], + "Type: ClippingPlane": [ + { + "group": "Type: ClippingPlane", + "type": "Number[3]", + "optional": false, + "field": "normal", + "description": "

The normal of the plane defined for the clipping plane

" + }, + { + "group": "Type: ClippingPlane", + "type": "Number", + "optional": false, + "field": "distance", + "description": "

The distance for the clipping plane to the origin

" + }, + { + "group": "Type: ClippingPlane", + "type": "Number", + "optional": false, + "field": "clipDirection", + "description": "

The direction to the clipping plane will cut the model; above or below the plane. Possible values: 1 , -1.

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/viewpoints/00000000-0000-0000-0000-000000000001 HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"_id\":\"00000000-0000-0000-0000-000000000001\",\n\t\"thumbnail\":\"charence/00000000-0000-0000-0000-000000000000/viewpoints/00000000-0000-0000-0000-000000000001/thumbnail.png\",\n\t\"viewpoint\":{\n\t\t\"right\":[1.0,-0.0,0.0],\n\t\t\"up\":[0.0,0.0,-1.0],\n\t\t\"position\":[35000.0,150000.0,20000.0],\n\t\t\"look_at\":[35000.0,3000.0,20000.0],\n\t\t\"view_dir\":[-0.0,-1,-0.0],\n\t\t\"near\":100.0,\n\t\t\"far\":100000.0,\n\t\t\"fov\":1.0,\n\t\t\"aspect_ratio\":1.185,\n\t\t\"clippingPlanes\":[],\n\t\t\"highlighted_group_id\":\"\"\n\t},\n\t\"clippingPlanes\":[],\n\t\"screenshot\":{\n\t\t\"thumbnailUrl\":,\n\t\t\"thumbnail\":\"charence/00000000-0000-0000-0000-000000000000/viewpoints/00000000-0000-0000-0000-000000000001/thumbnail.png\"\n\t},\n\t\"name\":\"View1\"\n}", + "type": "png" + } + ], + "fields": { + "View object": [ + { + "group": "View object", + "type": "String", + "optional": false, + "field": "_id", + "description": "

View ID

" + }, + { + "group": "View object", + "type": "String", + "optional": false, + "field": "name", + "description": "

Name of view

" + }, + { + "group": "View object", + "type": "String", + "optional": false, + "field": "thumbnail", + "description": "

Thumbnail image

" + }, + { + "group": "View object", + "type": "ResultViewpoint", + "optional": false, + "field": "viewpoint", + "description": "

Viewpoint properties

" + }, + { + "group": "View object", + "type": "Number[]", + "optional": false, + "field": "clippingPlanes", + "description": "

[DEPRECATED] Array of clipping planes

" + }, + { + "group": "View object", + "type": "Object", + "optional": false, + "field": "screenshot", + "description": "

[DEPRECATED] Screenshot object

" + } + ] + } + }, + "version": "0.0.0", + "filename": "src/v4/routes/view.js", + "groupTitle": "Views" + }, + { + "type": "get", + "url": "/:teamspace/:model/viewpoints/:viewId/thumbnail.png", + "title": "Get view thumbnail", + "name": "getThumbnail", + "group": "Views", + "description": "

Retrieve a view's thumbnail image.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "viewId", + "description": "

View ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/viewpoints/00000000-0000-0000-0000-000000000000/thumbnail.png HTTP/1.1", + "type": "get" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n", + "type": "png" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/view.js", + "groupTitle": "Views" + }, + { + "type": "get", + "url": "/:teamspace/:model/viewpoints", + "title": "List all views", + "name": "listViews", + "group": "Views", + "description": "

List all model views.

", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Object[]", + "optional": false, + "field": "views", + "description": "

List of view objects

" + } + ], + "View object": [ + { + "group": "View object", + "type": "String", + "optional": false, + "field": "_id", + "description": "

View ID

" + }, + { + "group": "View object", + "type": "String", + "optional": false, + "field": "name", + "description": "

Name of view

" + }, + { + "group": "View object", + "type": "String", + "optional": false, + "field": "thumbnail", + "description": "

Thumbnail image

" + }, + { + "group": "View object", + "type": "ResultViewpoint", + "optional": false, + "field": "viewpoint", + "description": "

Viewpoint properties

" + }, + { + "group": "View object", + "type": "Number[]", + "optional": false, + "field": "clippingPlanes", + "description": "

[DEPRECATED] Array of clipping planes

" + }, + { + "group": "View object", + "type": "Object", + "optional": false, + "field": "screenshot", + "description": "

[DEPRECATED] Screenshot object

" + } + ] + }, + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n[\n\t{\n\t\t\"_id\":\"00000000-0000-0000-0000-000000000001\",\n\t\t\"thumbnail\":\"charence/00000000-0000-0000-0000-000000000000/viewpoints/00000000-0000-0000-0000-000000000001/thumbnail.png\",\n\t\t\"viewpoint\":{\n\t\t\t\"right\":[1.0,-0.0,0.0],\n\t\t\t\"up\":[0.0,0.0,-1.0],\n\t\t\t\"position\":[35000.0,150000.0,20000.0],\n\t\t\t\"look_at\":[35000.0,3000.0,20000.0],\n\t\t\t\"view_dir\":[-0.0,-1,-0.0],\n\t\t\t\"near\":100.0,\n\t\t\t\"far\":100000.0,\n\t\t\t\"fov\":1.0,\n\t\t\t\"aspect_ratio\":1.185,\n\t\t\t\"clippingPlanes\":[],\n\t\t\t\"highlighted_group_id\":\"\"\n\t\t},\n\t\t\"clippingPlanes\":[],\n\t\t\"screenshot\":{\n\t\t\t\"thumbnailUrl\":,\n\t\t\t\"thumbnail\":\"charence/00000000-0000-0000-0000-000000000000/viewpoints/00000000-0000-0000-0000-000000000001/thumbnail.png\"\n\t\t},\n\t\t\"name\":\"View1\"\n\t},\n\t{\n\t\t\"_id\":\"00000000-0000-0000-0000-000000000002\",\n\t\t\"thumbnail\":\"charence/00000000-0000-0000-0000-000000000000/viewpoints/00000000-0000-0000-0000-000000000002/thumbnail.png\",\n\t\t\"viewpoint\":{\n\t\t\t\"right\":[1.0,-0.0,0.5],\n\t\t\t\"up\":[0.0,0.0,-1.0],\n\t\t\t\"position\":[20000.0,-50000.0,10000.0],\n\t\t\t\"look_at\":[20000.0,5000.0,10000.0],\n\t\t\t\"view_dir\":[0.0,-1,0.0],\n\t\t\t\"near\":100.0,\n\t\t\t\"far\":100000.0,\n\t\t\t\"fov\":1.0,\n\t\t\t\"aspect_ratio\":1.185,\n\t\t\t\"clippingPlanes\":[],\n\t\t\t\"highlighted_group_id\":\"\"\n\t\t},\n\t\t\"clippingPlanes\":[],\n\t\t\"screenshot\":{\n\t\t\t\"thumbnailUrl\":,\n\t\t\t\"thumbnail\":\"charence/00000000-0000-0000-0000-000000000000/viewpoints/00000000-0000-0000-0000-000000000002/thumbnail.png\"\n\t\t},\n\t\t\"name\":\"View2\"\n\t}\n]", + "type": "png" + } + ] + }, + "examples": [ + { + "title": "Example usage:", + "content": "GET /acme/00000000-0000-0000-0000-000000000000/viewpoints HTTP/1.1", + "type": "get" + } + ], + "version": "0.0.0", + "filename": "src/v4/routes/view.js", + "groupTitle": "Views", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Type: ResultViewpoint": [ + { + "group": "Type: ResultViewpoint", + "type": "Number[3]", + "optional": false, + "field": "right", + "description": "

The right vector of the viewpoint indicating the direction of right in relative coordinates.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number[3]", + "optional": false, + "field": "up", + "description": "

The up vector of the viewpoint indicating the direction of up in relative coordinates.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number[3]", + "optional": false, + "field": "position", + "description": "

The position vector indicates where in the world the viewpoint is positioned.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number[3]", + "optional": false, + "field": "look_at", + "description": "

The vector indicating where in the world the viewpoint is looking at.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number[3]", + "optional": false, + "field": "view_dir", + "description": "

The vector indicating where is the viewpoint is looking at in relative coordinates.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number", + "optional": false, + "field": "near", + "description": "

The vector indicating the near plane.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number", + "optional": false, + "field": "far", + "description": "

The vector indicating the far plane.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number", + "optional": false, + "field": "fov", + "description": "

The angle of the field of view.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Number", + "optional": false, + "field": "aspect_ratio", + "description": "

The aspect ratio of the fustrum.

" + }, + { + "group": "Type: ResultViewpoint", + "type": "ClippingPlane[]", + "optional": true, + "field": "clippingPlanes", + "description": "

the clipping planes associated with the viewpoint

" + }, + { + "group": "Type: ResultViewpoint", + "type": "String", + "optional": true, + "field": "highlighted_group_id", + "description": "

If the viewpoint is associated with one or more highlighted objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: ResultViewpoint", + "type": "String", + "optional": true, + "field": "hidden_group_id", + "description": "

If the viewpoint is associated with one or more hidden objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: ResultViewpoint", + "type": "String", + "optional": true, + "field": "shown_group_id", + "description": "

If the viewpoint is associated with one or more shown objects from the model this field has the value of a group id generated to hold those objects

" + }, + { + "group": "Type: ResultViewpoint", + "type": "String[]", + "optional": true, + "field": "override_group_ids", + "description": "

If the viewpoint has one or more objects with colour override this field has an array of groups ids with one group for each colour

" + }, + { + "group": "Type: ResultViewpoint", + "type": "String[]", + "optional": true, + "field": "transformation_group_ids", + "description": "

List of group IDs with transformations

" + }, + { + "group": "Type: ResultViewpoint", + "type": "Boolean", + "optional": false, + "field": "hide_IFC", + "description": "

A flag to hide the IFC

" + }, + { + "group": "Type: ResultViewpoint", + "type": "String", + "optional": false, + "field": "screenshot", + "description": "

A string in base64 representing the screenshot associated with the viewpoint

" + } + ], + "Type: ClippingPlane": [ + { + "group": "Type: ClippingPlane", + "type": "Number[3]", + "optional": false, + "field": "normal", + "description": "

The normal of the plane defined for the clipping plane

" + }, + { + "group": "Type: ClippingPlane", + "type": "Number", + "optional": false, + "field": "distance", + "description": "

The distance for the clipping plane to the origin

" + }, + { + "group": "Type: ClippingPlane", + "type": "Number", + "optional": false, + "field": "clipDirection", + "description": "

The direction to the clipping plane will cut the model; above or below the plane. Possible values: 1 , -1.

" + } + ] + } + } + }, + { + "type": "put", + "url": "/:teamspace/:model/viewpoints/:viewId", + "title": "Update view", + "name": "updateView", + "group": "Views", + "description": "

Update a view.

", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "viewId", + "description": "

View ID

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "teamspace", + "description": "

Name of teamspace

" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "model", + "description": "

Model ID

" + } + ], + "Request body": [ + { + "group": "Request body", + "type": "String", + "optional": false, + "field": "name", + "description": "

Name of view

" + } + ] + } + }, + "examples": [ + { + "title": "Example usage:", + "content": "PUT /acme/00000000-0000-0000-0000-000000000000/viewpoints/00000000-0000-0000-0000-000000000001 HTTP/1.1\n{\n\t\"name\":\"NewName\"\n}", + "type": "put" + } + ], + "success": { + "examples": [ + { + "title": "Success-Response", + "content": "HTTP/1.1 200 OK\n{\n\t\"_id\":\"00000000-0000-0000-0000-000000000001\"\n}", + "type": "png" + } + ] + }, + "version": "0.0.0", + "filename": "src/v4/routes/view.js", + "groupTitle": "Views" + } +] diff --git a/backend/docs/api_project.js b/backend/docs/api_project.js new file mode 100644 index 00000000000..4eb47801d9c --- /dev/null +++ b/backend/docs/api_project.js @@ -0,0 +1,14 @@ +define({ + "name": "3drepo.io", + "version": "5.6.3", + "description": "The backend for 3drepo.io", + "sampleUrl": false, + "defaultVersion": "0.0.0", + "apidoc": "0.3.0", + "generator": { + "name": "apidoc", + "time": "2024-01-22T16:31:45.319Z", + "url": "http://apidocjs.com", + "version": "0.17.7" + } +}); diff --git a/backend/docs/api_project.json b/backend/docs/api_project.json new file mode 100644 index 00000000000..57bdd3ea9d8 --- /dev/null +++ b/backend/docs/api_project.json @@ -0,0 +1,14 @@ +{ + "name": "3drepo.io", + "version": "5.6.3", + "description": "The backend for 3drepo.io", + "sampleUrl": false, + "defaultVersion": "0.0.0", + "apidoc": "0.3.0", + "generator": { + "name": "apidoc", + "time": "2024-01-22T16:31:45.319Z", + "url": "http://apidocjs.com", + "version": "0.17.7" + } +} diff --git a/backend/docs/css/style.css b/backend/docs/css/style.css new file mode 100644 index 00000000000..6468b2b22d2 --- /dev/null +++ b/backend/docs/css/style.css @@ -0,0 +1,569 @@ +/* ------------------------------------------------------------------------------------------ + * Content + * ------------------------------------------------------------------------------------------ */ +body { + min-width: 980px; + max-width: 1280px; +} + +body, p, a, div, th, td { + font-family: "Source Sans Pro", sans-serif; + font-weight: 400; + font-size: 16px; +} + +td.code { + font-size: 14px; + font-family: "Source Code Pro", monospace; + font-style: normal; + font-weight: 400; +} + +#content { + padding-top: 16px; + z-Index: -1; + margin-left: 270px; +} + +p { + color: #808080; +} + +h1 { + font-family: "Source Sans Pro Semibold", sans-serif; + font-weight: normal; + font-size: 44px; + line-height: 50px; + margin: 0 0 10px 0; + padding: 0; +} + +h2 { + font-family: "Source Sans Pro", sans-serif; + font-weight: normal; + font-size: 24px; + line-height: 40px; + margin: 0 0 20px 0; + padding: 0; +} + +section { + border-top: 1px solid #ebebeb; + padding: 30px 0; +} + +section h1 { + font-family: "Source Sans Pro", sans-serif; + font-weight: 700; + font-size: 32px; + line-height: 40px; + padding-bottom: 14px; + margin: 0 0 20px 0; + padding: 0; +} + +article { + padding: 14px 0 30px 0; +} + +article h1 { + font-family: "Source Sans Pro Bold", sans-serif; + font-weight: 600; + font-size: 24px; + line-height: 26px; +} + +article h2 { + font-family: "Source Sans Pro", sans-serif; + font-weight: 600; + font-size: 18px; + line-height: 24px; + margin: 0 0 10px 0; +} + +article h3 { + font-family: "Source Sans Pro", sans-serif; + font-weight: 600; + font-size: 16px; + line-height: 18px; + margin: 0 0 10px 0; +} + +article h4 { + font-family: "Source Sans Pro", sans-serif; + font-weight: 600; + font-size: 14px; + line-height: 16px; + margin: 0 0 8px 0; +} + +table { + border-collapse: collapse; + width: 100%; + margin: 0 0 20px 0; +} + +th { + background-color: #f5f5f5; + text-align: left; + font-family: "Source Sans Pro", sans-serif; + font-weight: 700; + padding: 4px 8px; + border: #e0e0e0 1px solid; +} + +td { + vertical-align: top; + padding: 10px 8px 0 8px; + border: #e0e0e0 1px solid; +} + +#generator .content { + color: #b0b0b0; + border-top: 1px solid #ebebeb; + padding: 10px 0; +} + +.label-optional { + float: right; + background-color: grey; + margin-top: 4px; +} + +.open-left { + right: 0; + left: auto; +} + +/* ------------------------------------------------------------------------------------------ + * apidoc - intro + * ------------------------------------------------------------------------------------------ */ + +#apidoc .apidoc { + border-top: 1px solid #ebebeb; + padding: 30px 0; +} + +#apidoc h1 { + font-family: "Source Sans Pro", sans-serif; + font-weight: 700; + font-size: 32px; + line-height: 40px; + padding-bottom: 14px; + margin: 0 0 20px 0; + padding: 0; +} + +#apidoc h2 { + font-family: "Source Sans Pro Bold", sans-serif; + font-weight: 600; + font-size: 22px; + line-height: 26px; + padding-top: 14px; +} + +/* ------------------------------------------------------------------------------------------ + * pre / code + * ------------------------------------------------------------------------------------------ */ +pre { + background-color: #292b36; + color: #ffffff; + padding: 10px; + border-radius: 6px; + position: relative; + margin: 10px 0 20px 0; + overflow-x: auto; +} + +pre.prettyprint { + width: 100%; +} + +code.language-text { + word-wrap: break-word; +} + +pre.language-json { + overflow: auto; +} + +pre.language-html { + margin: 0 0 20px 0; +} + +.type { + font-family: "Source Sans Pro", sans-serif; + font-weight: 600; + font-size: 15px; + display: inline-block; + margin: 0 0 5px 0; + padding: 4px 5px; + border-radius: 6px; + text-transform: uppercase; + background-color: #3387CC; + color: #ffffff; +} + +.type__get { + background-color: green; +} + +.type__put { + background-color: #e5c500; +} + +.type__post { + background-color: #4070ec; +} + +.type__delete { + background-color: #ed0039; +} + +pre.language-api .str { + color: #ffffff; +} + +pre.language-api .pln, +pre.language-api .pun { + color: #65B042; +} + +pre code { + display: block; + font-size: 14px; + font-family: "Source Code Pro", monospace; + font-style: normal; + font-weight: 400; + word-wrap: normal; + white-space: pre; +} + +pre code.sample-request-response-json { + white-space: pre-wrap; + max-height: 500px; + overflow: auto; +} + +/* ------------------------------------------------------------------------------------------ + * Sidenav + * ------------------------------------------------------------------------------------------ */ +.sidenav { + width: 228px; + margin: 0; + padding: 0 20px 20px 20px; + position: fixed; + top: 50px; + left: 0; + bottom: 0; + overflow-x: hidden; + overflow-y: auto; + background-color: #f5f5f5; + z-index: 10; +} + +.sidenav > li > a { + display: block; + width: 192px; + margin: 0; + padding: 2px 11px; + border: 0; + border-left: transparent 4px solid; + border-right: transparent 4px solid; + font-family: "Source Sans Pro", sans-serif; + font-weight: 400; + font-size: 14px; +} + +.sidenav > li.nav-header { + margin-top: 8px; + margin-bottom: 8px; +} + +.sidenav > li.nav-header > a { + padding: 5px 15px; + border: 1px solid #e5e5e5; + width: 190px; + font-family: "Source Sans Pro", sans-serif; + font-weight: 700; + font-size: 16px; + background-color: #ffffff; +} + +.sidenav > li.active > a { + position: relative; + z-index: 2; + background-color: #0088cc; + color: #ffffff; +} + +.sidenav > li.has-modifications a { + border-right: #60d060 4px solid; +} + +.sidenav > li.is-new a { + border-left: #e5e5e5 4px solid; +} + +/* ------------------------------------------------------------------------------------------ + * Side nav search + * ------------------------------------------------------------------------------------------ */ +.sidenav-search { + width: 228px; + left: 0px; + position: fixed; + padding: 16px 20px 10px 20px; + background-color: #F5F5F5; + z-index: 11; +} + +.sidenav-search .search { + height: 26px; +} + +.search-reset { + position: absolute; + display: block; + cursor: pointer; + width: 20px; + height: 20px; + text-align: center; + right: 28px; + top: 17px; + background-color: #fff; +} + +/* ------------------------------------------------------------------------------------------ + * Compare + * ------------------------------------------------------------------------------------------ */ + +ins { + background: #60d060; + text-decoration: none; + color: #000000; +} + +del { + background: #f05050; + color: #000000; +} + +.label-ins { + background-color: #60d060; +} + +.label-del { + background-color: #f05050; + text-decoration: line-through; +} + +pre.ins { + background-color: #60d060; +} + +pre.del { + background-color: #f05050; + text-decoration: line-through; +} + +table.ins th, +table.ins td { + background-color: #60d060; +} + +table.del th, +table.del td { + background-color: #f05050; + text-decoration: line-through; +} + +tr.ins td { + background-color: #60d060; +} + +tr.del td { + background-color: #f05050; + text-decoration: line-through; +} + +/* ------------------------------------------------------------------------------------------ + * Spinner + * ------------------------------------------------------------------------------------------ */ + +#loader { + position: absolute; + width: 100%; +} + +#loader p { + padding-top: 80px; + margin-left: -4px; +} + +.spinner { + margin: 200px auto; + width: 60px; + height: 60px; + position: relative; +} + +.container1 > div, .container2 > div, .container3 > div { + width: 14px; + height: 14px; + background-color: #0088cc; + + border-radius: 100%; + position: absolute; + -webkit-animation: bouncedelay 1.2s infinite ease-in-out; + animation: bouncedelay 1.2s infinite ease-in-out; + /* Prevent first frame from flickering when animation starts */ + -webkit-animation-fill-mode: both; + animation-fill-mode: both; +} + +.spinner .spinner-container { + position: absolute; + width: 100%; + height: 100%; +} + +.container2 { + -webkit-transform: rotateZ(45deg); + transform: rotateZ(45deg); +} + +.container3 { + -webkit-transform: rotateZ(90deg); + transform: rotateZ(90deg); +} + +.circle1 { top: 0; left: 0; } +.circle2 { top: 0; right: 0; } +.circle3 { right: 0; bottom: 0; } +.circle4 { left: 0; bottom: 0; } + +.container2 .circle1 { + -webkit-animation-delay: -1.1s; + animation-delay: -1.1s; +} + +.container3 .circle1 { + -webkit-animation-delay: -1.0s; + animation-delay: -1.0s; +} + +.container1 .circle2 { + -webkit-animation-delay: -0.9s; + animation-delay: -0.9s; +} + +.container2 .circle2 { + -webkit-animation-delay: -0.8s; + animation-delay: -0.8s; +} + +.container3 .circle2 { + -webkit-animation-delay: -0.7s; + animation-delay: -0.7s; +} + +.container1 .circle3 { + -webkit-animation-delay: -0.6s; + animation-delay: -0.6s; +} + +.container2 .circle3 { + -webkit-animation-delay: -0.5s; + animation-delay: -0.5s; +} + +.container3 .circle3 { + -webkit-animation-delay: -0.4s; + animation-delay: -0.4s; +} + +.container1 .circle4 { + -webkit-animation-delay: -0.3s; + animation-delay: -0.3s; +} + +.container2 .circle4 { + -webkit-animation-delay: -0.2s; + animation-delay: -0.2s; +} + +.container3 .circle4 { + -webkit-animation-delay: -0.1s; + animation-delay: -0.1s; +} + +@-webkit-keyframes bouncedelay { + 0%, 80%, 100% { -webkit-transform: scale(0.0) } + 40% { -webkit-transform: scale(1.0) } +} + +@keyframes bouncedelay { + 0%, 80%, 100% { + transform: scale(0.0); + -webkit-transform: scale(0.0); + } 40% { + transform: scale(1.0); + -webkit-transform: scale(1.0); + } +} + +/* ------------------------------------------------------------------------------------------ + * Tabs + * ------------------------------------------------------------------------------------------ */ +ul.nav-tabs { + margin: 0; +} + +p.deprecated span{ + color: #ff0000; + font-weight: bold; + text-decoration: underline; +} + +/* ------------------------------------------------------------------------------------------ + * Print + * ------------------------------------------------------------------------------------------ */ + +@media print { + + #sidenav, + #version, + #versions, + section .version, + section .versions { + display: none; + } + + #content { + margin-left: 0; + } + + a { + text-decoration: none; + color: inherit; + } + + a:after { + content: " [" attr(href) "] "; + } + + p { + color: #000000 + } + + pre { + background-color: #ffffff; + color: #000000; + padding: 10px; + border: #808080 1px solid; + border-radius: 6px; + position: relative; + margin: 10px 0 20px 0; + } + +} /* /@media print */ diff --git a/backend/docs/fonts/glyphicons-halflings-regular.eot b/backend/docs/fonts/glyphicons-halflings-regular.eot new file mode 100644 index 00000000000..b93a4953fff Binary files /dev/null and b/backend/docs/fonts/glyphicons-halflings-regular.eot differ diff --git a/backend/docs/fonts/glyphicons-halflings-regular.svg b/backend/docs/fonts/glyphicons-halflings-regular.svg new file mode 100644 index 00000000000..94fb5490a2e --- /dev/null +++ b/backend/docs/fonts/glyphicons-halflings-regular.svg @@ -0,0 +1,288 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/backend/docs/fonts/glyphicons-halflings-regular.ttf b/backend/docs/fonts/glyphicons-halflings-regular.ttf new file mode 100644 index 00000000000..1413fc609ab Binary files /dev/null and b/backend/docs/fonts/glyphicons-halflings-regular.ttf differ diff --git a/backend/docs/fonts/glyphicons-halflings-regular.woff b/backend/docs/fonts/glyphicons-halflings-regular.woff new file mode 100644 index 00000000000..9e612858f80 Binary files /dev/null and b/backend/docs/fonts/glyphicons-halflings-regular.woff differ diff --git a/backend/docs/fonts/glyphicons-halflings-regular.woff2 b/backend/docs/fonts/glyphicons-halflings-regular.woff2 new file mode 100644 index 00000000000..64539b54c37 Binary files /dev/null and b/backend/docs/fonts/glyphicons-halflings-regular.woff2 differ diff --git a/backend/docs/img/favicon.ico b/backend/docs/img/favicon.ico new file mode 100644 index 00000000000..c307a043933 Binary files /dev/null and b/backend/docs/img/favicon.ico differ diff --git a/backend/docs/index.html b/backend/docs/index.html new file mode 100644 index 00000000000..5f04deda546 --- /dev/null +++ b/backend/docs/index.html @@ -0,0 +1,669 @@ + + + + + Loading... + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ +
+ +
+
+
+
+ +
+ +
+ + + + diff --git a/backend/docs/locales/ca.js b/backend/docs/locales/ca.js new file mode 100644 index 00000000000..65af5df2b72 --- /dev/null +++ b/backend/docs/locales/ca.js @@ -0,0 +1,25 @@ +define({ + ca: { + 'Allowed values:' : 'Valors permesos:', + 'Compare all with predecessor': 'Comparar tot amb versió anterior', + 'compare changes to:' : 'comparar canvis amb:', + 'compared to' : 'comparat amb', + 'Default value:' : 'Valor per defecte:', + 'Description' : 'Descripció', + 'Field' : 'Camp', + 'General' : 'General', + 'Generated with' : 'Generat amb', + 'Name' : 'Nom', + 'No response values.' : 'Sense valors en la resposta.', + 'optional' : 'opcional', + 'Parameter' : 'Paràmetre', + 'Permission:' : 'Permisos:', + 'Response' : 'Resposta', + 'Send' : 'Enviar', + 'Send a Sample Request' : 'Enviar una petició d\'exemple', + 'show up to version:' : 'mostrar versió:', + 'Size range:' : 'Tamany de rang:', + 'Type' : 'Tipus', + 'url' : 'url' + } +}); diff --git a/backend/docs/locales/cs.js b/backend/docs/locales/cs.js new file mode 100644 index 00000000000..b7796d8f8ed --- /dev/null +++ b/backend/docs/locales/cs.js @@ -0,0 +1,25 @@ +define({ + cs: { + 'Allowed values:' : 'Povolené hodnoty:', + 'Compare all with predecessor': 'Porovnat vše s předchozími verzemi', + 'compare changes to:' : 'porovnat změny s:', + 'compared to' : 'porovnat s', + 'Default value:' : 'Výchozí hodnota:', + 'Description' : 'Popis', + 'Field' : 'Pole', + 'General' : 'Obecné', + 'Generated with' : 'Vygenerováno pomocí', + 'Name' : 'Název', + 'No response values.' : 'Nebyly vráceny žádné hodnoty.', + 'optional' : 'volitelné', + 'Parameter' : 'Parametr', + 'Permission:' : 'Oprávnění:', + 'Response' : 'Odpověď', + 'Send' : 'Odeslat', + 'Send a Sample Request' : 'Odeslat ukázkový požadavek', + 'show up to version:' : 'zobrazit po verzi:', + 'Size range:' : 'Rozsah velikosti:', + 'Type' : 'Typ', + 'url' : 'url' + } +}); diff --git a/backend/docs/locales/de.js b/backend/docs/locales/de.js new file mode 100644 index 00000000000..f66420d0093 --- /dev/null +++ b/backend/docs/locales/de.js @@ -0,0 +1,25 @@ +define({ + de: { + 'Allowed values:' : 'Erlaubte Werte:', + 'Compare all with predecessor': 'Vergleiche alle mit ihren Vorgängern', + 'compare changes to:' : 'vergleiche Änderungen mit:', + 'compared to' : 'verglichen mit', + 'Default value:' : 'Standardwert:', + 'Description' : 'Beschreibung', + 'Field' : 'Feld', + 'General' : 'Allgemein', + 'Generated with' : 'Erstellt mit', + 'Name' : 'Name', + 'No response values.' : 'Keine Rückgabewerte.', + 'optional' : 'optional', + 'Parameter' : 'Parameter', + 'Permission:' : 'Berechtigung:', + 'Response' : 'Antwort', + 'Send' : 'Senden', + 'Send a Sample Request' : 'Eine Beispielanfrage senden', + 'show up to version:' : 'zeige bis zur Version:', + 'Size range:' : 'Größenbereich:', + 'Type' : 'Typ', + 'url' : 'url' + } +}); diff --git a/backend/docs/locales/es.js b/backend/docs/locales/es.js new file mode 100644 index 00000000000..3d47e800e8f --- /dev/null +++ b/backend/docs/locales/es.js @@ -0,0 +1,25 @@ +define({ + es: { + 'Allowed values:' : 'Valores permitidos:', + 'Compare all with predecessor': 'Comparar todo con versión anterior', + 'compare changes to:' : 'comparar cambios con:', + 'compared to' : 'comparado con', + 'Default value:' : 'Valor por defecto:', + 'Description' : 'Descripción', + 'Field' : 'Campo', + 'General' : 'General', + 'Generated with' : 'Generado con', + 'Name' : 'Nombre', + 'No response values.' : 'Sin valores en la respuesta.', + 'optional' : 'opcional', + 'Parameter' : 'Parámetro', + 'Permission:' : 'Permisos:', + 'Response' : 'Respuesta', + 'Send' : 'Enviar', + 'Send a Sample Request' : 'Enviar una petición de ejemplo', + 'show up to version:' : 'mostrar a versión:', + 'Size range:' : 'Tamaño de rango:', + 'Type' : 'Tipo', + 'url' : 'url' + } +}); diff --git a/backend/docs/locales/fr.js b/backend/docs/locales/fr.js new file mode 100644 index 00000000000..100a642917b --- /dev/null +++ b/backend/docs/locales/fr.js @@ -0,0 +1,25 @@ +define({ + fr: { + 'Allowed values:' : 'Valeurs autorisées :', + 'Compare all with predecessor': 'Tout comparer avec ...', + 'compare changes to:' : 'comparer les changements à :', + 'compared to' : 'comparer à', + 'Default value:' : 'Valeur par défaut :', + 'Description' : 'Description', + 'Field' : 'Champ', + 'General' : 'Général', + 'Generated with' : 'Généré avec', + 'Name' : 'Nom', + 'No response values.' : 'Aucune valeur de réponse.', + 'optional' : 'optionnel', + 'Parameter' : 'Paramètre', + 'Permission:' : 'Permission :', + 'Response' : 'Réponse', + 'Send' : 'Envoyer', + 'Send a Sample Request' : 'Envoyer une requête représentative', + 'show up to version:' : 'Montrer à partir de la version :', + 'Size range:' : 'Ordre de grandeur :', + 'Type' : 'Type', + 'url' : 'url' + } +}); diff --git a/backend/docs/locales/it.js b/backend/docs/locales/it.js new file mode 100644 index 00000000000..8117108cfdb --- /dev/null +++ b/backend/docs/locales/it.js @@ -0,0 +1,25 @@ +define({ + it: { + 'Allowed values:' : 'Valori permessi:', + 'Compare all with predecessor': 'Confronta tutto con versioni precedenti', + 'compare changes to:' : 'confronta modifiche con:', + 'compared to' : 'confrontato con', + 'Default value:' : 'Valore predefinito:', + 'Description' : 'Descrizione', + 'Field' : 'Campo', + 'General' : 'Generale', + 'Generated with' : 'Creato con', + 'Name' : 'Nome', + 'No response values.' : 'Nessun valore di risposta.', + 'optional' : 'opzionale', + 'Parameter' : 'Parametro', + 'Permission:' : 'Permessi:', + 'Response' : 'Risposta', + 'Send' : 'Invia', + 'Send a Sample Request' : 'Invia una richiesta di esempio', + 'show up to version:' : 'mostra alla versione:', + 'Size range:' : 'Intervallo dimensione:', + 'Type' : 'Tipo', + 'url' : 'url' + } +}); diff --git a/backend/docs/locales/locale.js b/backend/docs/locales/locale.js new file mode 100644 index 00000000000..3530705e341 --- /dev/null +++ b/backend/docs/locales/locale.js @@ -0,0 +1,51 @@ +define([ + './locales/ca.js', + './locales/cs.js', + './locales/de.js', + './locales/es.js', + './locales/fr.js', + './locales/it.js', + './locales/nl.js', + './locales/pl.js', + './locales/pt_br.js', + './locales/ro.js', + './locales/ru.js', + './locales/tr.js', + './locales/vi.js', + './locales/zh.js', + './locales/zh_cn.js' +], function() { + var langId = (navigator.language || navigator.userLanguage).toLowerCase().replace('-', '_'); + var language = langId.substr(0, 2); + var locales = {}; + + for (index in arguments) { + for (property in arguments[index]) + locales[property] = arguments[index][property]; + } + if ( ! locales['en']) + locales['en'] = {}; + + if ( ! locales[langId] && ! locales[language]) + language = 'en'; + + var locale = (locales[langId] ? locales[langId] : locales[language]); + + function __(text) { + var index = locale[text]; + if (index === undefined) + return text; + return index; + }; + + function setLanguage(language) { + locale = locales[language]; + } + + return { + __ : __, + locales : locales, + locale : locale, + setLanguage: setLanguage + }; +}); diff --git a/backend/docs/locales/nl.js b/backend/docs/locales/nl.js new file mode 100644 index 00000000000..bddfeeb18d0 --- /dev/null +++ b/backend/docs/locales/nl.js @@ -0,0 +1,25 @@ +define({ + nl: { + 'Allowed values:' : 'Toegestane waarden:', + 'Compare all with predecessor': 'Vergelijk alle met voorgaande versie', + 'compare changes to:' : 'vergelijk veranderingen met:', + 'compared to' : 'vergelijk met', + 'Default value:' : 'Standaard waarde:', + 'Description' : 'Omschrijving', + 'Field' : 'Veld', + 'General' : 'Algemeen', + 'Generated with' : 'Gegenereerd met', + 'Name' : 'Naam', + 'No response values.' : 'Geen response waardes.', + 'optional' : 'optioneel', + 'Parameter' : 'Parameter', + 'Permission:' : 'Permissie:', + 'Response' : 'Antwoorden', + 'Send' : 'Sturen', + 'Send a Sample Request' : 'Stuur een sample aanvragen', + 'show up to version:' : 'toon tot en met versie:', + 'Size range:' : 'Maatbereik:', + 'Type' : 'Type', + 'url' : 'url' + } +}); diff --git a/backend/docs/locales/pl.js b/backend/docs/locales/pl.js new file mode 100644 index 00000000000..db645ee16c9 --- /dev/null +++ b/backend/docs/locales/pl.js @@ -0,0 +1,25 @@ +define({ + pl: { + 'Allowed values:' : 'Dozwolone wartości:', + 'Compare all with predecessor': 'Porównaj z poprzednimi wersjami', + 'compare changes to:' : 'porównaj zmiany do:', + 'compared to' : 'porównaj do:', + 'Default value:' : 'Wartość domyślna:', + 'Description' : 'Opis', + 'Field' : 'Pole', + 'General' : 'Generalnie', + 'Generated with' : 'Wygenerowano z', + 'Name' : 'Nazwa', + 'No response values.' : 'Brak odpowiedzi.', + 'optional' : 'opcjonalny', + 'Parameter' : 'Parametr', + 'Permission:' : 'Uprawnienia:', + 'Response' : 'Odpowiedź', + 'Send' : 'Wyślij', + 'Send a Sample Request' : 'Wyślij przykładowe żądanie', + 'show up to version:' : 'pokaż do wersji:', + 'Size range:' : 'Zakres rozmiaru:', + 'Type' : 'Typ', + 'url' : 'url' + } +}); diff --git a/backend/docs/locales/pt_br.js b/backend/docs/locales/pt_br.js new file mode 100644 index 00000000000..2bd78b0d386 --- /dev/null +++ b/backend/docs/locales/pt_br.js @@ -0,0 +1,25 @@ +define({ + 'pt_br': { + 'Allowed values:' : 'Valores permitidos:', + 'Compare all with predecessor': 'Compare todos com antecessores', + 'compare changes to:' : 'comparar alterações com:', + 'compared to' : 'comparado com', + 'Default value:' : 'Valor padrão:', + 'Description' : 'Descrição', + 'Field' : 'Campo', + 'General' : 'Geral', + 'Generated with' : 'Gerado com', + 'Name' : 'Nome', + 'No response values.' : 'Sem valores de resposta.', + 'optional' : 'opcional', + 'Parameter' : 'Parâmetro', + 'Permission:' : 'Permissão:', + 'Response' : 'Resposta', + 'Send' : 'Enviar', + 'Send a Sample Request' : 'Enviar um Exemplo de Pedido', + 'show up to version:' : 'aparecer para a versão:', + 'Size range:' : 'Faixa de tamanho:', + 'Type' : 'Tipo', + 'url' : 'url' + } +}); diff --git a/backend/docs/locales/ro.js b/backend/docs/locales/ro.js new file mode 100644 index 00000000000..8d4e4ed8723 --- /dev/null +++ b/backend/docs/locales/ro.js @@ -0,0 +1,25 @@ +define({ + ro: { + 'Allowed values:' : 'Valori permise:', + 'Compare all with predecessor': 'Compară toate cu versiunea precedentă', + 'compare changes to:' : 'compară cu versiunea:', + 'compared to' : 'comparat cu', + 'Default value:' : 'Valoare implicită:', + 'Description' : 'Descriere', + 'Field' : 'Câmp', + 'General' : 'General', + 'Generated with' : 'Generat cu', + 'Name' : 'Nume', + 'No response values.' : 'Nici o valoare returnată.', + 'optional' : 'opțional', + 'Parameter' : 'Parametru', + 'Permission:' : 'Permisiune:', + 'Response' : 'Răspuns', + 'Send' : 'Trimite', + 'Send a Sample Request' : 'Trimite o cerere de probă', + 'show up to version:' : 'arată până la versiunea:', + 'Size range:' : 'Interval permis:', + 'Type' : 'Tip', + 'url' : 'url' + } +}); diff --git a/backend/docs/locales/ru.js b/backend/docs/locales/ru.js new file mode 100644 index 00000000000..c5f33821410 --- /dev/null +++ b/backend/docs/locales/ru.js @@ -0,0 +1,25 @@ +define({ + ru: { + 'Allowed values:' : 'Допустимые значения:', + 'Compare all with predecessor': 'Сравнить с предыдущей версией', + 'compare changes to:' : 'сравнить с:', + 'compared to' : 'в сравнении с', + 'Default value:' : 'По умолчанию:', + 'Description' : 'Описание', + 'Field' : 'Название', + 'General' : 'Общая информация', + 'Generated with' : 'Сгенерировано с помощью', + 'Name' : 'Название', + 'No response values.' : 'Нет значений для ответа.', + 'optional' : 'необязательный', + 'Parameter' : 'Параметр', + 'Permission:' : 'Разрешено:', + 'Response' : 'Ответ', + 'Send' : 'Отправить', + 'Send a Sample Request' : 'Отправить тестовый запрос', + 'show up to version:' : 'показать версию:', + 'Size range:' : 'Ограничения:', + 'Type' : 'Тип', + 'url' : 'URL' + } +}); diff --git a/backend/docs/locales/tr.js b/backend/docs/locales/tr.js new file mode 100644 index 00000000000..5c64e52dabe --- /dev/null +++ b/backend/docs/locales/tr.js @@ -0,0 +1,25 @@ +define({ + tr: { + 'Allowed values:' : 'İzin verilen değerler:', + 'Compare all with predecessor': 'Tümünü öncekiler ile karşılaştır', + 'compare changes to:' : 'değişiklikleri karşılaştır:', + 'compared to' : 'karşılaştır', + 'Default value:' : 'Varsayılan değer:', + 'Description' : 'Açıklama', + 'Field' : 'Alan', + 'General' : 'Genel', + 'Generated with' : 'Oluşturan', + 'Name' : 'İsim', + 'No response values.' : 'Dönüş verisi yok.', + 'optional' : 'opsiyonel', + 'Parameter' : 'Parametre', + 'Permission:' : 'İzin:', + 'Response' : 'Dönüş', + 'Send' : 'Gönder', + 'Send a Sample Request' : 'Örnek istek gönder', + 'show up to version:' : 'bu versiyona kadar göster:', + 'Size range:' : 'Boyut aralığı:', + 'Type' : 'Tip', + 'url' : 'url' + } +}); diff --git a/backend/docs/locales/vi.js b/backend/docs/locales/vi.js new file mode 100644 index 00000000000..7ce77050748 --- /dev/null +++ b/backend/docs/locales/vi.js @@ -0,0 +1,25 @@ +define({ + vi: { + 'Allowed values:' : 'Giá trị chấp nhận:', + 'Compare all with predecessor': 'So sánh với tất cả phiên bản trước', + 'compare changes to:' : 'so sánh sự thay đổi với:', + 'compared to' : 'so sánh với', + 'Default value:' : 'Giá trị mặc định:', + 'Description' : 'Chú thích', + 'Field' : 'Trường dữ liệu', + 'General' : 'Tổng quan', + 'Generated with' : 'Được tạo bởi', + 'Name' : 'Tên', + 'No response values.' : 'Không có kết quả trả về.', + 'optional' : 'Tùy chọn', + 'Parameter' : 'Tham số', + 'Permission:' : 'Quyền hạn:', + 'Response' : 'Kết quả', + 'Send' : 'Gửi', + 'Send a Sample Request' : 'Gửi một yêu cầu mẫu', + 'show up to version:' : 'hiển thị phiên bản:', + 'Size range:' : 'Kích cỡ:', + 'Type' : 'Kiểu', + 'url' : 'liên kết' + } +}); diff --git a/backend/docs/locales/zh.js b/backend/docs/locales/zh.js new file mode 100644 index 00000000000..66522067f42 --- /dev/null +++ b/backend/docs/locales/zh.js @@ -0,0 +1,25 @@ +define({ + zh: { + 'Allowed values​​:' : '允許值:', + 'Compare all with predecessor': '預先比較所有', + 'compare changes to:' : '比較變更:', + 'compared to' : '對比', + 'Default value:' : '默認值:', + 'Description' : '描述', + 'Field' : '字段', + 'General' : '概括', + 'Generated with' : '生成工具', + 'Name' : '名稱', + 'No response values​​.' : '無對應資料.', + 'optional' : '選項', + 'Parameter' : '參數', + 'Permission:' : '允許:', + 'Response' : '回應', + 'Send' : '發送', + 'Send a Sample Request' : '發送試用需求', + 'show up to version:' : '顯示到版本:', + 'Size range:' : '尺寸範圍:', + 'Type' : '類型', + 'url' : '網址' + } +}); diff --git a/backend/docs/locales/zh_cn.js b/backend/docs/locales/zh_cn.js new file mode 100644 index 00000000000..1938ca184b4 --- /dev/null +++ b/backend/docs/locales/zh_cn.js @@ -0,0 +1,25 @@ +define({ + 'zh_cn': { + 'Allowed values:' : '允许值:', + 'Compare all with predecessor': '与所有较早的比较', + 'compare changes to:' : '将当前版本与指定版本比较:', + 'compared to' : '相比于', + 'Default value:' : '默认值:', + 'Description' : '描述', + 'Field' : '字段', + 'General' : '概要', + 'Generated with' : '基于', + 'Name' : '名称', + 'No response values.' : '无返回值.', + 'optional' : '可选', + 'Parameter' : '参数', + 'Permission:' : '权限:', + 'Response' : '返回', + 'Send' : '发送', + 'Send a Sample Request' : '发送示例请求', + 'show up to version:' : '显示到指定版本:', + 'Size range:' : '取值范围:', + 'Type' : '类型', + 'url' : '网址' + } +}); diff --git a/backend/docs/main.js b/backend/docs/main.js new file mode 100644 index 00000000000..9d31fa5f6b5 --- /dev/null +++ b/backend/docs/main.js @@ -0,0 +1,827 @@ +require.config({ + paths: { + bootstrap: './vendor/bootstrap.min', + diffMatchPatch: './vendor/diff_match_patch.min', + handlebars: './vendor/handlebars.min', + handlebarsExtended: './utils/handlebars_helper', + jquery: './vendor/jquery.min', + locales: './locales/locale', + lodash: './vendor/lodash.custom.min', + pathToRegexp: './vendor/path-to-regexp/index', + prettify: './vendor/prettify/prettify', + semver: './vendor/semver.min', + utilsSampleRequest: './utils/send_sample_request', + webfontloader: './vendor/webfontloader', + list: './vendor/list.min' + }, + shim: { + bootstrap: { + deps: ['jquery'] + }, + diffMatchPatch: { + exports: 'diff_match_patch' + }, + handlebars: { + exports: 'Handlebars' + }, + handlebarsExtended: { + deps: ['jquery', 'handlebars'], + exports: 'Handlebars' + }, + prettify: { + exports: 'prettyPrint' + } + }, + urlArgs: 'v=' + (new Date()).getTime(), + waitSeconds: 15 +}); + +require([ + 'jquery', + 'lodash', + 'locales', + 'handlebarsExtended', + './api_project.js', + './api_data.js', + 'prettify', + 'utilsSampleRequest', + 'semver', + 'webfontloader', + 'bootstrap', + 'pathToRegexp', + 'list' +], function($, _, locale, Handlebars, apiProject, apiData, prettyPrint, sampleRequest, semver, WebFont) { + + // load google web fonts + loadGoogleFontCss(); + + var api = apiData.api; + + // + // Templates + // + var templateHeader = Handlebars.compile( $('#template-header').html() ); + var templateFooter = Handlebars.compile( $('#template-footer').html() ); + var templateArticle = Handlebars.compile( $('#template-article').html() ); + var templateCompareArticle = Handlebars.compile( $('#template-compare-article').html() ); + var templateGenerator = Handlebars.compile( $('#template-generator').html() ); + var templateProject = Handlebars.compile( $('#template-project').html() ); + var templateSections = Handlebars.compile( $('#template-sections').html() ); + var templateSidenav = Handlebars.compile( $('#template-sidenav').html() ); + + // + // apiProject defaults + // + if ( ! apiProject.template) + apiProject.template = {}; + + if (apiProject.template.withCompare == null) + apiProject.template.withCompare = true; + + if (apiProject.template.withGenerator == null) + apiProject.template.withGenerator = true; + + if (apiProject.template.forceLanguage) + locale.setLanguage(apiProject.template.forceLanguage); + + // Setup jQuery Ajax + $.ajaxSetup(apiProject.template.jQueryAjaxSetup); + + // + // Data transform + // + // grouped by group + var apiByGroup = _.groupBy(api, function(entry) { + return entry.group; + }); + + // grouped by group and name + var apiByGroupAndName = {}; + $.each(apiByGroup, function(index, entries) { + apiByGroupAndName[index] = _.groupBy(entries, function(entry) { + return entry.name; + }); + }); + + // + // sort api within a group by title ASC and custom order + // + var newList = []; + var umlauts = { 'ä': 'ae', 'ü': 'ue', 'ö': 'oe', 'ß': 'ss' }; // TODO: remove in version 1.0 + $.each (apiByGroupAndName, function(index, groupEntries) { + // get titles from the first entry of group[].name[] (name has versioning) + var titles = []; + $.each (groupEntries, function(titleName, entries) { + var title = entries[0].title; + if(title !== undefined) { + title.toLowerCase().replace(/[äöüß]/g, function($0) { return umlauts[$0]; }); + titles.push(title + '#~#' + titleName); // '#~#' keep reference to titleName after sorting + } + }); + // sort by name ASC + titles.sort(); + + // custom order + if (apiProject.order) + titles = sortByOrder(titles, apiProject.order, '#~#'); + + // add single elements to the new list + titles.forEach(function(name) { + var values = name.split('#~#'); + var key = values[1]; + groupEntries[key].forEach(function(entry) { + newList.push(entry); + }); + }); + }); + // api overwrite with ordered list + api = newList; + + // + // Group- and Versionlists + // + var apiGroups = {}; + var apiGroupTitles = {}; + var apiVersions = {}; + apiVersions[apiProject.version] = 1; + + $.each(api, function(index, entry) { + apiGroups[entry.group] = 1; + apiGroupTitles[entry.group] = entry.groupTitle || entry.group; + apiVersions[entry.version] = 1; + }); + + // sort groups + apiGroups = Object.keys(apiGroups); + apiGroups.sort(); + + // custom order + if (apiProject.order) + apiGroups = sortByOrder(apiGroups, apiProject.order); + + // sort versions DESC + apiVersions = Object.keys(apiVersions); + apiVersions.sort(semver.compare); + apiVersions.reverse(); + + // + // create Navigationlist + // + var nav = []; + apiGroups.forEach(function(group) { + // Mainmenu entry + nav.push({ + group: group, + isHeader: true, + title: apiGroupTitles[group] + }); + + // Submenu + var oldName = ''; + api.forEach(function(entry) { + if (entry.group === group) { + if (oldName !== entry.name) { + nav.push({ + title: entry.title, + group: group, + name: entry.name, + type: entry.type, + version: entry.version + }); + } else { + nav.push({ + title: entry.title, + group: group, + hidden: true, + name: entry.name, + type: entry.type, + version: entry.version + }); + } + oldName = entry.name; + } + }); + }); + + /** + * Add navigation items by analyzing the HTML content and searching for h1 and h2 tags + * @param nav Object the navigation array + * @param content string the compiled HTML content + * @param index where to insert items + * @return boolean true if any good-looking (i.e. with a group identifier)

tag was found + */ + function add_nav(nav, content, index) { + var found_level1 = false; + if ( ! content) { + return found_level1; + } + var topics = content.match(/(.+?)<\/h(1|2)>/gi); + if ( topics ) { + topics.forEach(function(entry) { + var level = entry.substring(2,3); + var title = entry.replace(/<.+?>/g, ''); // Remove all HTML tags for the title + var entry_tags = entry.match(/id="api-([^\-]+)(?:-(.+))?"/); // Find the group and name in the id property + var group = (entry_tags ? entry_tags[1] : null); + var name = (entry_tags ? entry_tags[2] : null); + if (level==1 && title && group) { + nav.splice(index, 0, { + group: group, + isHeader: true, + title: title, + isFixed: true + }); + index++; + found_level1 = true; + } + if (level==2 && title && group && name) { + nav.splice(index, 0, { + group: group, + name: name, + isHeader: false, + title: title, + isFixed: false, + version: '1.0' + }); + index++; + } + }); + } + return found_level1; + } + + // Mainmenu Header entry + if (apiProject.header) { + var found_level1 = add_nav(nav, apiProject.header.content, 0); // Add level 1 and 2 titles + if (!found_level1) { // If no Level 1 tags were found, make a title + nav.unshift({ + group: '_', + isHeader: true, + title: (apiProject.header.title == null) ? locale.__('General') : apiProject.header.title, + isFixed: true + }); + } + } + + // Mainmenu Footer entry + if (apiProject.footer) { + var last_nav_index = nav.length; + var found_level1 = add_nav(nav, apiProject.footer.content, nav.length); // Add level 1 and 2 titles + if (!found_level1 && apiProject.footer.title != null) { // If no Level 1 tags were found, make a title + nav.splice(last_nav_index, 0, { + group: '_footer', + isHeader: true, + title: apiProject.footer.title, + isFixed: true + }); + } + } + + // render pagetitle + var title = apiProject.title ? apiProject.title : 'apiDoc: ' + apiProject.name + ' - ' + apiProject.version; + $(document).attr('title', title); + + // remove loader + $('#loader').remove(); + + // render sidenav + var fields = { + nav: nav + }; + $('#sidenav').append( templateSidenav(fields) ); + + // render Generator + $('#generator').append( templateGenerator(apiProject) ); + + // render Project + _.extend(apiProject, { versions: apiVersions}); + $('#project').append( templateProject(apiProject) ); + + // render apiDoc, header/footer documentation + if (apiProject.header) + $('#header').append( templateHeader(apiProject.header) ); + + if (apiProject.footer) + $('#footer').append( templateFooter(apiProject.footer) ); + + // + // Render Sections and Articles + // + var articleVersions = {}; + var content = ''; + apiGroups.forEach(function(groupEntry) { + var articles = []; + var oldName = ''; + var fields = {}; + var title = groupEntry; + var description = ''; + articleVersions[groupEntry] = {}; + + // render all articles of a group + api.forEach(function(entry) { + if(groupEntry === entry.group) { + if (oldName !== entry.name) { + // determine versions + api.forEach(function(versionEntry) { + if (groupEntry === versionEntry.group && entry.name === versionEntry.name) { + if ( ! articleVersions[entry.group].hasOwnProperty(entry.name) ) { + articleVersions[entry.group][entry.name] = []; + } + articleVersions[entry.group][entry.name].push(versionEntry.version); + } + }); + fields = { + article: entry, + versions: articleVersions[entry.group][entry.name] + }; + } else { + fields = { + article: entry, + hidden: true, + versions: articleVersions[entry.group][entry.name] + }; + } + + // add prefix URL for endpoint + if (apiProject.url) + fields.article.url = apiProject.url + fields.article.url; + + addArticleSettings(fields, entry); + + if (entry.groupTitle) + title = entry.groupTitle; + + // TODO: make groupDescription compareable with older versions (not important for the moment) + if (entry.groupDescription) + description = entry.groupDescription; + + articles.push({ + article: templateArticle(fields), + group: entry.group, + name: entry.name + }); + oldName = entry.name; + } + }); + + // render Section with Articles + var fields = { + group: groupEntry, + title: title, + description: description, + articles: articles + }; + content += templateSections(fields); + }); + $('#sections').append( content ); + + // Bootstrap Scrollspy + $(this).scrollspy({ target: '#scrollingNav', offset: 18 }); + + // Content-Scroll on Navigation click. + $('.sidenav').find('a').on('click', function(e) { + e.preventDefault(); + var id = $(this).attr('href'); + if ($(id).length > 0) + $('html,body').animate({ scrollTop: parseInt($(id).offset().top) }, 400); + window.location.hash = $(this).attr('href'); + }); + + // Quickjump on Pageload to hash position. + if(window.location.hash) { + var id = window.location.hash; + if ($(id).length > 0) + $('html,body').animate({ scrollTop: parseInt($(id).offset().top) }, 0); + } + + /** + * Check if Parameter (sub) List has a type Field. + * Example: @apiSuccess varname1 No type. + * @apiSuccess {String} varname2 With type. + * + * @param {Object} fields + */ + function _hasTypeInFields(fields) { + var result = false; + $.each(fields, function(name) { + result = result || _.some(fields[name], function(item) { return item.type; }); + }); + return result; + } + + /** + * On Template changes, recall plugins. + */ + function initDynamic() { + // Bootstrap popover + $('button[data-toggle="popover"]').popover().click(function(e) { + e.preventDefault(); + }); + + var version = $('#version strong').html(); + $('#sidenav li').removeClass('is-new'); + if (apiProject.template.withCompare) { + $('#sidenav li[data-version=\'' + version + '\']').each(function(){ + var group = $(this).data('group'); + var name = $(this).data('name'); + var length = $('#sidenav li[data-group=\'' + group + '\'][data-name=\'' + name + '\']').length; + var index = $('#sidenav li[data-group=\'' + group + '\'][data-name=\'' + name + '\']').index($(this)); + if (length === 1 || index === (length - 1)) + $(this).addClass('is-new'); + }); + } + + // tabs + $('.nav-tabs-examples a').click(function (e) { + e.preventDefault(); + $(this).tab('show'); + }); + $('.nav-tabs-examples').find('a:first').tab('show'); + + // sample request switch + $('.sample-request-switch').click(function (e) { + var name = '.' + $(this).attr('name') + '-fields'; + $(name).addClass('hide'); + $(this).parent().next(name).removeClass('hide'); + }); + + // call scrollspy refresh method + $(window).scrollspy('refresh'); + + // init modules + sampleRequest.initDynamic(); + } + initDynamic(); + + // Pre- / Code-Format + prettyPrint(); + + // + // HTML-Template specific jQuery-Functions + // + // Change Main Version + $('#versions li.version a').on('click', function(e) { + e.preventDefault(); + + var selectedVersion = $(this).html(); + $('#version strong').html(selectedVersion); + + // hide all + $('article').addClass('hide'); + $('#sidenav li:not(.nav-fixed)').addClass('hide'); + + // show 1st equal or lower Version of each entry + $('article[data-version]').each(function(index) { + var group = $(this).data('group'); + var name = $(this).data('name'); + var version = $(this).data('version'); + + if (semver.lte(version, selectedVersion)) { + if ($('article[data-group=\'' + group + '\'][data-name=\'' + name + '\']:visible').length === 0) { + // enable Article + $('article[data-group=\'' + group + '\'][data-name=\'' + name + '\'][data-version=\'' + version + '\']').removeClass('hide'); + // enable Navigation + $('#sidenav li[data-group=\'' + group + '\'][data-name=\'' + name + '\'][data-version=\'' + version + '\']').removeClass('hide'); + $('#sidenav li.nav-header[data-group=\'' + group + '\']').removeClass('hide'); + } + } + }); + + // show 1st equal or lower Version of each entry + $('article[data-version]').each(function(index) { + var group = $(this).data('group'); + $('section#api-' + group).removeClass('hide'); + if ($('section#api-' + group + ' article:visible').length === 0) { + $('section#api-' + group).addClass('hide'); + } else { + $('section#api-' + group).removeClass('hide'); + } + }); + + initDynamic(); + return; + }); + + // compare all article with their predecessor + $('#compareAllWithPredecessor').on('click', changeAllVersionCompareTo); + + // change version of an article + $('article .versions li.version a').on('click', changeVersionCompareTo); + + // compare url-parameter + $.urlParam = function(name) { + var results = new RegExp('[\\?&]' + name + '=([^&#]*)').exec(window.location.href); + return (results && results[1]) ? results[1] : null; + }; + + if ($.urlParam('compare')) { + // URL Paramter ?compare=1 is set + $('#compareAllWithPredecessor').trigger('click'); + + if (window.location.hash) { + var id = window.location.hash; + $('html,body').animate({ scrollTop: parseInt($(id).offset().top) - 18 }, 0); + } + } + + /** + * Initialize search + */ + var options = { + valueNames: [ 'nav-list-item' ] + }; + var endpointsList = new List('scrollingNav', options); + + /** + * Set initial focus to search input + */ + $('#scrollingNav .sidenav-search input.search').focus(); + + /** + * Detect ESC key to reset search + */ + $(document).keyup(function(e) { + if (e.keyCode === 27) $('span.search-reset').click(); + }); + + /** + * Search reset + */ + $('span.search-reset').on('click', function() { + $('#scrollingNav .sidenav-search input.search') + .val("") + .focus() + ; + endpointsList.search(); + }); + + /** + * Change version of an article to compare it to an other version. + */ + function changeVersionCompareTo(e) { + e.preventDefault(); + + var $root = $(this).parents('article'); + var selectedVersion = $(this).html(); + var $button = $root.find('.version'); + var currentVersion = $button.find('strong').html(); + $button.find('strong').html(selectedVersion); + + var group = $root.data('group'); + var name = $root.data('name'); + var version = $root.data('version'); + + var compareVersion = $root.data('compare-version'); + + if (compareVersion === selectedVersion) + return; + + if ( ! compareVersion && version == selectedVersion) + return; + + if (compareVersion && articleVersions[group][name][0] === selectedVersion || version === selectedVersion) { + // the version of the entry is set to the highest version (reset) + resetArticle(group, name, version); + } else { + var $compareToArticle = $('article[data-group=\'' + group + '\'][data-name=\'' + name + '\'][data-version=\'' + selectedVersion + '\']'); + + var sourceEntry = {}; + var compareEntry = {}; + $.each(apiByGroupAndName[group][name], function(index, entry) { + if (entry.version === version) + sourceEntry = entry; + if (entry.version === selectedVersion) + compareEntry = entry; + }); + + var fields = { + article: sourceEntry, + compare: compareEntry, + versions: articleVersions[group][name] + }; + + // add unique id + // TODO: replace all group-name-version in template with id. + fields.article.id = fields.article.group + '-' + fields.article.name + '-' + fields.article.version; + fields.article.id = fields.article.id.replace(/\./g, '_'); + + fields.compare.id = fields.compare.group + '-' + fields.compare.name + '-' + fields.compare.version; + fields.compare.id = fields.compare.id.replace(/\./g, '_'); + + var entry = sourceEntry; + if (entry.parameter && entry.parameter.fields) + fields._hasTypeInParameterFields = _hasTypeInFields(entry.parameter.fields); + + if (entry.error && entry.error.fields) + fields._hasTypeInErrorFields = _hasTypeInFields(entry.error.fields); + + if (entry.success && entry.success.fields) + fields._hasTypeInSuccessFields = _hasTypeInFields(entry.success.fields); + + if (entry.info && entry.info.fields) + fields._hasTypeInInfoFields = _hasTypeInFields(entry.info.fields); + + var entry = compareEntry; + if (fields._hasTypeInParameterFields !== true && entry.parameter && entry.parameter.fields) + fields._hasTypeInParameterFields = _hasTypeInFields(entry.parameter.fields); + + if (fields._hasTypeInErrorFields !== true && entry.error && entry.error.fields) + fields._hasTypeInErrorFields = _hasTypeInFields(entry.error.fields); + + if (fields._hasTypeInSuccessFields !== true && entry.success && entry.success.fields) + fields._hasTypeInSuccessFields = _hasTypeInFields(entry.success.fields); + + if (fields._hasTypeInInfoFields !== true && entry.info && entry.info.fields) + fields._hasTypeInInfoFields = _hasTypeInFields(entry.info.fields); + + var content = templateCompareArticle(fields); + $root.after(content); + var $content = $root.next(); + + // Event on.click re-assign + $content.find('.versions li.version a').on('click', changeVersionCompareTo); + + // select navigation + $('#sidenav li[data-group=\'' + group + '\'][data-name=\'' + name + '\'][data-version=\'' + currentVersion + '\']').addClass('has-modifications'); + + $root.remove(); + // TODO: on change main version or select the highest version re-render + } + + initDynamic(); + } + + /** + * Compare all currently selected Versions with their predecessor. + */ + function changeAllVersionCompareTo(e) { + e.preventDefault(); + $('article:visible .versions').each(function(){ + var $root = $(this).parents('article'); + var currentVersion = $root.data('version'); + var $foundElement = null; + $(this).find('li.version a').each(function() { + var selectVersion = $(this).html(); + if (selectVersion < currentVersion && ! $foundElement) + $foundElement = $(this); + }); + + if($foundElement) + $foundElement.trigger('click'); + }); + initDynamic(); + } + + /** + * Sort the fields. + */ + function sortFields(fields_object) { + $.each(fields_object, function (key, fields) { + + var reversed = fields.slice().reverse() + + var max_dot_count = Math.max.apply(null, reversed.map(function (item) { + return item.field.split(".").length - 1; + })) + + for (var dot_count = 1; dot_count <= max_dot_count; dot_count++) { + reversed.forEach(function (item, index) { + var parts = item.field.split("."); + if (parts.length - 1 == dot_count) { + var fields_names = fields.map(function (item) { return item.field; }); + if (parts.slice(1).length >= 1) { + var prefix = parts.slice(0, parts.length - 1).join("."); + var prefix_index = fields_names.indexOf(prefix); + if (prefix_index > -1) { + fields.splice(fields_names.indexOf(item.field), 1); + fields.splice(prefix_index + 1, 0, item); + } + } + } + }); + } + }); + } + + /** + * Add article settings. + */ + function addArticleSettings(fields, entry) { + // add unique id + // TODO: replace all group-name-version in template with id. + fields.id = fields.article.group + '-' + fields.article.name + '-' + fields.article.version; + fields.id = fields.id.replace(/\./g, '_'); + + if (entry.header && entry.header.fields) { + sortFields(entry.header.fields); + fields._hasTypeInHeaderFields = _hasTypeInFields(entry.header.fields); + } + + if (entry.parameter && entry.parameter.fields) { + sortFields(entry.parameter.fields); + fields._hasTypeInParameterFields = _hasTypeInFields(entry.parameter.fields); + } + + if (entry.error && entry.error.fields) { + sortFields(entry.error.fields); + fields._hasTypeInErrorFields = _hasTypeInFields(entry.error.fields); + } + + if (entry.success && entry.success.fields) { + sortFields(entry.success.fields); + fields._hasTypeInSuccessFields = _hasTypeInFields(entry.success.fields); + } + + if (entry.info && entry.info.fields) { + sortFields(entry.info.fields); + fields._hasTypeInInfoFields = _hasTypeInFields(entry.info.fields); + } + + // add template settings + fields.template = apiProject.template; + } + + /** + * Render Article. + */ + function renderArticle(group, name, version) { + var entry = {}; + $.each(apiByGroupAndName[group][name], function(index, currentEntry) { + if (currentEntry.version === version) + entry = currentEntry; + }); + var fields = { + article: entry, + versions: articleVersions[group][name] + }; + + addArticleSettings(fields, entry); + + return templateArticle(fields); + } + + /** + * Render original Article and remove the current visible Article. + */ + function resetArticle(group, name, version) { + var $root = $('article[data-group=\'' + group + '\'][data-name=\'' + name + '\']:visible'); + var content = renderArticle(group, name, version); + + $root.after(content); + var $content = $root.next(); + + // Event on.click muss neu zugewiesen werden (sollte eigentlich mit on automatisch funktionieren... sollte) + $content.find('.versions li.version a').on('click', changeVersionCompareTo); + + $('#sidenav li[data-group=\'' + group + '\'][data-name=\'' + name + '\'][data-version=\'' + version + '\']').removeClass('has-modifications'); + + $root.remove(); + return; + } + + /** + * Load google fonts. + */ + function loadGoogleFontCss() { + WebFont.load({ + active: function() { + // Update scrollspy + $(window).scrollspy('refresh') + }, + google: { + families: ['Source Code Pro', 'Source Sans Pro:n4,n6,n7'] + } + }); + } + + /** + * Return ordered entries by custom order and append not defined entries to the end. + * @param {String[]} elements + * @param {String[]} order + * @param {String} splitBy + * @return {String[]} Custom ordered list. + */ + function sortByOrder(elements, order, splitBy) { + var results = []; + order.forEach (function(name) { + if (splitBy) + elements.forEach (function(element) { + var parts = element.split(splitBy); + var key = parts[1]; // reference keep for sorting + if (key == name) + results.push(element); + }); + else + elements.forEach (function(key) { + if (key == name) + results.push(name); + }); + }); + // Append all other entries that ar not defined in order + elements.forEach(function(element) { + if (results.indexOf(element) === -1) + results.push(element); + }); + return results; + } + +}); diff --git a/backend/docs/utils/handlebars_helper.js b/backend/docs/utils/handlebars_helper.js new file mode 100644 index 00000000000..a5d5c4fdcf9 --- /dev/null +++ b/backend/docs/utils/handlebars_helper.js @@ -0,0 +1,357 @@ +define([ + 'locales', + 'handlebars', + 'diffMatchPatch' +], function(locale, Handlebars, DiffMatchPatch) { + + /** + * Return a text as markdown. + * Currently only a little helper to replace apidoc-inline Links (#Group:Name). + * Should be replaced with a full markdown lib. + * @param string text + */ + Handlebars.registerHelper('markdown', function(text) { + if ( ! text ) { + return text; + } + text = text.replace(/((\[(.*?)\])?\(#)((.+?):(.+?))(\))/mg, function(match, p1, p2, p3, p4, p5, p6) { + var link = p3 || p5 + '/' + p6; + return '' + link + ''; + }); + return text; + }); + + /** + * start/stop timer for simple performance check. + */ + var timer; + Handlebars.registerHelper('startTimer', function(text) { + timer = new Date(); + return ''; + }); + + Handlebars.registerHelper('stopTimer', function(text) { + console.log(new Date() - timer); + return ''; + }); + + /** + * Return localized Text. + * @param string text + */ + Handlebars.registerHelper('__', function(text) { + return locale.__(text); + }); + + /** + * Console log. + * @param mixed obj + */ + Handlebars.registerHelper('cl', function(obj) { + console.log(obj); + return ''; + }); + + /** + * Replace underscore with space. + * @param string text + */ + Handlebars.registerHelper('underscoreToSpace', function(text) { + return text.replace(/(_+)/g, ' '); + }); + + /** + * + */ + Handlebars.registerHelper('assign', function(name) { + if(arguments.length > 0) { + var type = typeof(arguments[1]); + var arg = null; + if(type === 'string' || type === 'number' || type === 'boolean') arg = arguments[1]; + Handlebars.registerHelper(name, function() { return arg; }); + } + return ''; + }); + + /** + * + */ + Handlebars.registerHelper('nl2br', function(text) { + return _handlebarsNewlineToBreak(text); + }); + + /** + * + */ + Handlebars.registerHelper('if_eq', function(context, options) { + var compare = context; + // Get length if context is an object + if (context instanceof Object && ! (options.hash.compare instanceof Object)) + compare = Object.keys(context).length; + + if (compare === options.hash.compare) + return options.fn(this); + + return options.inverse(this); + }); + + /** + * + */ + Handlebars.registerHelper('if_gt', function(context, options) { + var compare = context; + // Get length if context is an object + if (context instanceof Object && ! (options.hash.compare instanceof Object)) + compare = Object.keys(context).length; + + if(compare > options.hash.compare) + return options.fn(this); + + return options.inverse(this); + }); + + /** + * + */ + var templateCache = {}; + Handlebars.registerHelper('subTemplate', function(name, sourceContext) { + if ( ! templateCache[name]) + templateCache[name] = Handlebars.compile($('#template-' + name).html()); + + var template = templateCache[name]; + var templateContext = $.extend({}, this, sourceContext.hash); + return new Handlebars.SafeString( template(templateContext) ); + }); + + /** + * + */ + Handlebars.registerHelper('toLowerCase', function(value) { + return (value && typeof value === 'string') ? value.toLowerCase() : ''; + }); + + /** + * + */ + Handlebars.registerHelper('splitFill', function(value, splitChar, fillChar) { + var splits = value.split(splitChar); + return new Array(splits.length).join(fillChar) + splits[splits.length - 1]; + }); + + /** + * Convert Newline to HTML-Break (nl2br). + * + * @param {String} text + * @returns {String} + */ + function _handlebarsNewlineToBreak(text) { + return ('' + text).replace(/([^>\r\n]?)(\r\n|\n\r|\r|\n)/g, '$1' + '
' + '$2'); + } + + /** + * + */ + Handlebars.registerHelper('each_compare_list_field', function(source, compare, options) { + var fieldName = options.hash.field; + var newSource = []; + if (source) { + source.forEach(function(entry) { + var values = entry; + values['key'] = entry[fieldName]; + newSource.push(values); + }); + } + + var newCompare = []; + if (compare) { + compare.forEach(function(entry) { + var values = entry; + values['key'] = entry[fieldName]; + newCompare.push(values); + }); + } + return _handlebarsEachCompared('key', newSource, newCompare, options); + }); + + /** + * + */ + Handlebars.registerHelper('each_compare_keys', function(source, compare, options) { + var newSource = []; + if (source) { + var sourceFields = Object.keys(source); + sourceFields.forEach(function(name) { + var values = {}; + values['value'] = source[name]; + values['key'] = name; + newSource.push(values); + }); + } + + var newCompare = []; + if (compare) { + var compareFields = Object.keys(compare); + compareFields.forEach(function(name) { + var values = {}; + values['value'] = compare[name]; + values['key'] = name; + newCompare.push(values); + }); + } + return _handlebarsEachCompared('key', newSource, newCompare, options); + }); + + /** + * + */ + Handlebars.registerHelper('each_compare_field', function(source, compare, options) { + return _handlebarsEachCompared('field', source, compare, options); + }); + + /** + * + */ + Handlebars.registerHelper('each_compare_title', function(source, compare, options) { + return _handlebarsEachCompared('title', source, compare, options); + }); + + /** + * + */ + Handlebars.registerHelper('reformat', function(source, type){ + if (type == 'json') + try { + return JSON.stringify(JSON.parse(source.trim()),null, " "); + } catch(e) { + + } + return source + }); + + /** + * + */ + Handlebars.registerHelper('showDiff', function(source, compare, options) { + var ds = ''; + if(source === compare) { + ds = source; + } else { + if( ! source) + return compare; + + if( ! compare) + return source; + + var d = diffMatchPatch.diff_main(compare, source); + diffMatchPatch.diff_cleanupSemantic(d); + ds = diffMatchPatch.diff_prettyHtml(d); + ds = ds.replace(/¶/gm, ''); + } + if(options === 'nl2br') + ds = _handlebarsNewlineToBreak(ds); + + return ds; + }); + + /** + * + */ + function _handlebarsEachCompared(fieldname, source, compare, options) + { + var dataList = []; + var index = 0; + if(source) { + source.forEach(function(sourceEntry) { + var found = false; + if (compare) { + compare.forEach(function(compareEntry) { + if(sourceEntry[fieldname] === compareEntry[fieldname]) { + var data = { + typeSame: true, + source: sourceEntry, + compare: compareEntry, + index: index + }; + dataList.push(data); + found = true; + index++; + } + }); + } + if ( ! found) { + var data = { + typeIns: true, + source: sourceEntry, + index: index + }; + dataList.push(data); + index++; + } + }); + } + + if (compare) { + compare.forEach(function(compareEntry) { + var found = false; + if (source) { + source.forEach(function(sourceEntry) { + if(sourceEntry[fieldname] === compareEntry[fieldname]) + found = true; + }); + } + if ( ! found) { + var data = { + typeDel: true, + compare: compareEntry, + index: index + }; + dataList.push(data); + index++; + } + }); + } + + var ret = ''; + var length = dataList.length; + for (var index in dataList) { + if(index == (length - 1)) + dataList[index]['_last'] = true; + ret = ret + options.fn(dataList[index]); + } + return ret; + } + + var diffMatchPatch = new DiffMatchPatch(); + + /** + * Overwrite Colors + */ + DiffMatchPatch.prototype.diff_prettyHtml = function(diffs) { + var html = []; + var pattern_amp = /&/g; + var pattern_lt = //g; + var pattern_para = /\n/g; + for (var x = 0; x < diffs.length; x++) { + var op = diffs[x][0]; // Operation (insert, delete, equal) + var data = diffs[x][1]; // Text of change. + var text = data.replace(pattern_amp, '&').replace(pattern_lt, '<') + .replace(pattern_gt, '>').replace(pattern_para, '¶
'); + switch (op) { + case DIFF_INSERT: + html[x] = '' + text + ''; + break; + case DIFF_DELETE: + html[x] = '' + text + ''; + break; + case DIFF_EQUAL: + html[x] = '' + text + ''; + break; + } + } + return html.join(''); + }; + + // Exports + return Handlebars; +}); diff --git a/backend/docs/utils/send_sample_request.js b/backend/docs/utils/send_sample_request.js new file mode 100644 index 00000000000..f2396ea92e2 --- /dev/null +++ b/backend/docs/utils/send_sample_request.js @@ -0,0 +1,184 @@ +define([ + 'jquery', + 'lodash' +], function($, _) { + + var initDynamic = function() { + // Button send + $(".sample-request-send").off("click"); + $(".sample-request-send").on("click", function(e) { + e.preventDefault(); + var $root = $(this).parents("article"); + var group = $root.data("group"); + var name = $root.data("name"); + var version = $root.data("version"); + sendSampleRequest(group, name, version, $(this).data("sample-request-type")); + }); + + // Button clear + $(".sample-request-clear").off("click"); + $(".sample-request-clear").on("click", function(e) { + e.preventDefault(); + var $root = $(this).parents("article"); + var group = $root.data("group"); + var name = $root.data("name"); + var version = $root.data("version"); + clearSampleRequest(group, name, version); + }); + }; // initDynamic + + function sendSampleRequest(group, name, version, type) + { + var $root = $('article[data-group="' + group + '"][data-name="' + name + '"][data-version="' + version + '"]'); + + // Optional header + var header = {}; + $root.find(".sample-request-header:checked").each(function(i, element) { + var group = $(element).data("sample-request-header-group-id"); + $root.find("[data-sample-request-header-group=\"" + group + "\"]").each(function(i, element) { + var key = $(element).data("sample-request-header-name"); + var value = element.value; + if ( ! element.optional && element.defaultValue !== '') { + value = element.defaultValue; + } + header[key] = value; + }); + }); + + // create JSON dictionary of parameters + var param = {}; + var paramType = {}; + $root.find(".sample-request-param:checked").each(function(i, element) { + var group = $(element).data("sample-request-param-group-id"); + $root.find("[data-sample-request-param-group=\"" + group + "\"]").not(function(){ + return $(this).val() == "" && $(this).is("[data-sample-request-param-optional='true']"); + }).each(function(i, element) { + var key = $(element).data("sample-request-param-name"); + var value = element.value; + if ( ! element.optional && element.defaultValue !== '') { + value = element.defaultValue; + } + param[key] = value; + paramType[key] = $(element).next().text(); + }); + }); + + // grab user-inputted URL + var url = $root.find(".sample-request-url").val(); + + // Insert url parameter + var pattern = pathToRegexp(url, null); + var matches = pattern.exec(url); + for (var i = 1; i < matches.length; i++) { + var key = matches[i].substr(1); + if (param[key] !== undefined) { + url = url.replace(matches[i], encodeURIComponent(param[key])); + + // remove URL parameters from list + delete param[key]; + } + } // for + + $root.find(".sample-request-response").fadeTo(250, 1); + $root.find(".sample-request-response-json").html("Loading..."); + refreshScrollSpy(); + + _.each( param, function( val, key ) { + var t = paramType[ key ].toLowerCase(); + if ( t === 'object' || t === 'array' ) { + try { + param[ key ] = JSON.parse( val ); + } catch (e) { + } + } + }); + + // send AJAX request, catch success or error callback + var ajaxRequest = { + url : url, + headers : header, + data : param, + type : type.toUpperCase(), + success : displaySuccess, + error : displayError + }; + + $.ajax(ajaxRequest); + + + function displaySuccess(data, status, jqXHR) { + var jsonResponse; + try { + jsonResponse = JSON.parse(jqXHR.responseText); + jsonResponse = JSON.stringify(jsonResponse, null, 4); + } catch (e) { + jsonResponse = data; + } + $root.find(".sample-request-response-json").html(jsonResponse); + refreshScrollSpy(); + }; + + function displayError(jqXHR, textStatus, error) { + var message = "Error " + jqXHR.status + ": " + error; + var jsonResponse; + try { + jsonResponse = JSON.parse(jqXHR.responseText); + jsonResponse = JSON.stringify(jsonResponse, null, 4); + } catch (e) { + jsonResponse = escape(jqXHR.responseText); + } + + if (jsonResponse) + message += "
" + jsonResponse; + + // flicker on previous error to make clear that there is a new response + if($root.find(".sample-request-response").is(":visible")) + $root.find(".sample-request-response").fadeTo(1, 0.1); + + $root.find(".sample-request-response").fadeTo(250, 1); + $root.find(".sample-request-response-json").html(message); + refreshScrollSpy(); + }; + } + + function clearSampleRequest(group, name, version) + { + var $root = $('article[data-group="' + group + '"][data-name="' + name + '"][data-version="' + version + '"]'); + + // hide sample response + $root.find(".sample-request-response-json").html(""); + $root.find(".sample-request-response").hide(); + + // reset value of parameters + $root.find(".sample-request-param").each(function(i, element) { + element.value = ""; + }); + + // restore default URL + var $urlElement = $root.find(".sample-request-url"); + $urlElement.val($urlElement.prop("defaultValue")); + + refreshScrollSpy(); + } + + function refreshScrollSpy() + { + $('[data-spy="scroll"]').each(function () { + $(this).scrollspy("refresh"); + }); + } + + function escapeHtml(str) { + var div = document.createElement("div"); + div.appendChild(document.createTextNode(str)); + return div.innerHTML; + } + + /** + * Exports. + */ + return { + initDynamic: initDynamic + }; + +}); diff --git a/backend/docs/vendor/bootstrap.min.css b/backend/docs/vendor/bootstrap.min.css new file mode 100644 index 00000000000..ed3905e0e0c --- /dev/null +++ b/backend/docs/vendor/bootstrap.min.css @@ -0,0 +1,6 @@ +/*! + * Bootstrap v3.3.7 (http://getbootstrap.com) + * Copyright 2011-2016 Twitter, Inc. + * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE) + *//*! normalize.css v3.0.3 | MIT License | github.com/necolas/normalize.css */html{font-family:sans-serif;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}article,aside,details,figcaption,figure,footer,header,hgroup,main,menu,nav,section,summary{display:block}audio,canvas,progress,video{display:inline-block;vertical-align:baseline}audio:not([controls]){display:none;height:0}[hidden],template{display:none}a{background-color:transparent}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}dfn{font-style:italic}h1{margin:.67em 0;font-size:2em}mark{color:#000;background:#ff0}small{font-size:80%}sub,sup{position:relative;font-size:75%;line-height:0;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}img{border:0}svg:not(:root){overflow:hidden}figure{margin:1em 40px}hr{height:0;-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box}pre{overflow:auto}code,kbd,pre,samp{font-family:monospace,monospace;font-size:1em}button,input,optgroup,select,textarea{margin:0;font:inherit;color:inherit}button{overflow:visible}button,select{text-transform:none}button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}button[disabled],html input[disabled]{cursor:default}button::-moz-focus-inner,input::-moz-focus-inner{padding:0;border:0}input{line-height:normal}input[type=checkbox],input[type=radio]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;padding:0}input[type=number]::-webkit-inner-spin-button,input[type=number]::-webkit-outer-spin-button{height:auto}input[type=search]{-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box;-webkit-appearance:textfield}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}fieldset{padding:.35em .625em .75em;margin:0 2px;border:1px solid silver}legend{padding:0;border:0}textarea{overflow:auto}optgroup{font-weight:700}table{border-spacing:0;border-collapse:collapse}td,th{padding:0}/*! Source: https://github.com/h5bp/html5-boilerplate/blob/master/src/css/main.css */@media print{*,:after,:before{color:#000!important;text-shadow:none!important;background:0 0!important;-webkit-box-shadow:none!important;box-shadow:none!important}a,a:visited{text-decoration:underline}a[href]:after{content:" (" attr(href) ")"}abbr[title]:after{content:" (" attr(title) ")"}a[href^="javascript:"]:after,a[href^="#"]:after{content:""}blockquote,pre{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}h2,h3,p{orphans:3;widows:3}h2,h3{page-break-after:avoid}.navbar{display:none}.btn>.caret,.dropup>.btn>.caret{border-top-color:#000!important}.label{border:1px solid #000}.table{border-collapse:collapse!important}.table td,.table th{background-color:#fff!important}.table-bordered td,.table-bordered th{border:1px solid #ddd!important}}@font-face{font-family:'Glyphicons Halflings';src:url(../fonts/glyphicons-halflings-regular.eot);src:url(../fonts/glyphicons-halflings-regular.eot?#iefix) format('embedded-opentype'),url(../fonts/glyphicons-halflings-regular.woff2) format('woff2'),url(../fonts/glyphicons-halflings-regular.woff) format('woff'),url(../fonts/glyphicons-halflings-regular.ttf) format('truetype'),url(../fonts/glyphicons-halflings-regular.svg#glyphicons_halflingsregular) format('svg')}.glyphicon{position:relative;top:1px;display:inline-block;font-family:'Glyphicons Halflings';font-style:normal;font-weight:400;line-height:1;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.glyphicon-asterisk:before{content:"\002a"}.glyphicon-plus:before{content:"\002b"}.glyphicon-eur:before,.glyphicon-euro:before{content:"\20ac"}.glyphicon-minus:before{content:"\2212"}.glyphicon-cloud:before{content:"\2601"}.glyphicon-envelope:before{content:"\2709"}.glyphicon-pencil:before{content:"\270f"}.glyphicon-glass:before{content:"\e001"}.glyphicon-music:before{content:"\e002"}.glyphicon-search:before{content:"\e003"}.glyphicon-heart:before{content:"\e005"}.glyphicon-star:before{content:"\e006"}.glyphicon-star-empty:before{content:"\e007"}.glyphicon-user:before{content:"\e008"}.glyphicon-film:before{content:"\e009"}.glyphicon-th-large:before{content:"\e010"}.glyphicon-th:before{content:"\e011"}.glyphicon-th-list:before{content:"\e012"}.glyphicon-ok:before{content:"\e013"}.glyphicon-remove:before{content:"\e014"}.glyphicon-zoom-in:before{content:"\e015"}.glyphicon-zoom-out:before{content:"\e016"}.glyphicon-off:before{content:"\e017"}.glyphicon-signal:before{content:"\e018"}.glyphicon-cog:before{content:"\e019"}.glyphicon-trash:before{content:"\e020"}.glyphicon-home:before{content:"\e021"}.glyphicon-file:before{content:"\e022"}.glyphicon-time:before{content:"\e023"}.glyphicon-road:before{content:"\e024"}.glyphicon-download-alt:before{content:"\e025"}.glyphicon-download:before{content:"\e026"}.glyphicon-upload:before{content:"\e027"}.glyphicon-inbox:before{content:"\e028"}.glyphicon-play-circle:before{content:"\e029"}.glyphicon-repeat:before{content:"\e030"}.glyphicon-refresh:before{content:"\e031"}.glyphicon-list-alt:before{content:"\e032"}.glyphicon-lock:before{content:"\e033"}.glyphicon-flag:before{content:"\e034"}.glyphicon-headphones:before{content:"\e035"}.glyphicon-volume-off:before{content:"\e036"}.glyphicon-volume-down:before{content:"\e037"}.glyphicon-volume-up:before{content:"\e038"}.glyphicon-qrcode:before{content:"\e039"}.glyphicon-barcode:before{content:"\e040"}.glyphicon-tag:before{content:"\e041"}.glyphicon-tags:before{content:"\e042"}.glyphicon-book:before{content:"\e043"}.glyphicon-bookmark:before{content:"\e044"}.glyphicon-print:before{content:"\e045"}.glyphicon-camera:before{content:"\e046"}.glyphicon-font:before{content:"\e047"}.glyphicon-bold:before{content:"\e048"}.glyphicon-italic:before{content:"\e049"}.glyphicon-text-height:before{content:"\e050"}.glyphicon-text-width:before{content:"\e051"}.glyphicon-align-left:before{content:"\e052"}.glyphicon-align-center:before{content:"\e053"}.glyphicon-align-right:before{content:"\e054"}.glyphicon-align-justify:before{content:"\e055"}.glyphicon-list:before{content:"\e056"}.glyphicon-indent-left:before{content:"\e057"}.glyphicon-indent-right:before{content:"\e058"}.glyphicon-facetime-video:before{content:"\e059"}.glyphicon-picture:before{content:"\e060"}.glyphicon-map-marker:before{content:"\e062"}.glyphicon-adjust:before{content:"\e063"}.glyphicon-tint:before{content:"\e064"}.glyphicon-edit:before{content:"\e065"}.glyphicon-share:before{content:"\e066"}.glyphicon-check:before{content:"\e067"}.glyphicon-move:before{content:"\e068"}.glyphicon-step-backward:before{content:"\e069"}.glyphicon-fast-backward:before{content:"\e070"}.glyphicon-backward:before{content:"\e071"}.glyphicon-play:before{content:"\e072"}.glyphicon-pause:before{content:"\e073"}.glyphicon-stop:before{content:"\e074"}.glyphicon-forward:before{content:"\e075"}.glyphicon-fast-forward:before{content:"\e076"}.glyphicon-step-forward:before{content:"\e077"}.glyphicon-eject:before{content:"\e078"}.glyphicon-chevron-left:before{content:"\e079"}.glyphicon-chevron-right:before{content:"\e080"}.glyphicon-plus-sign:before{content:"\e081"}.glyphicon-minus-sign:before{content:"\e082"}.glyphicon-remove-sign:before{content:"\e083"}.glyphicon-ok-sign:before{content:"\e084"}.glyphicon-question-sign:before{content:"\e085"}.glyphicon-info-sign:before{content:"\e086"}.glyphicon-screenshot:before{content:"\e087"}.glyphicon-remove-circle:before{content:"\e088"}.glyphicon-ok-circle:before{content:"\e089"}.glyphicon-ban-circle:before{content:"\e090"}.glyphicon-arrow-left:before{content:"\e091"}.glyphicon-arrow-right:before{content:"\e092"}.glyphicon-arrow-up:before{content:"\e093"}.glyphicon-arrow-down:before{content:"\e094"}.glyphicon-share-alt:before{content:"\e095"}.glyphicon-resize-full:before{content:"\e096"}.glyphicon-resize-small:before{content:"\e097"}.glyphicon-exclamation-sign:before{content:"\e101"}.glyphicon-gift:before{content:"\e102"}.glyphicon-leaf:before{content:"\e103"}.glyphicon-fire:before{content:"\e104"}.glyphicon-eye-open:before{content:"\e105"}.glyphicon-eye-close:before{content:"\e106"}.glyphicon-warning-sign:before{content:"\e107"}.glyphicon-plane:before{content:"\e108"}.glyphicon-calendar:before{content:"\e109"}.glyphicon-random:before{content:"\e110"}.glyphicon-comment:before{content:"\e111"}.glyphicon-magnet:before{content:"\e112"}.glyphicon-chevron-up:before{content:"\e113"}.glyphicon-chevron-down:before{content:"\e114"}.glyphicon-retweet:before{content:"\e115"}.glyphicon-shopping-cart:before{content:"\e116"}.glyphicon-folder-close:before{content:"\e117"}.glyphicon-folder-open:before{content:"\e118"}.glyphicon-resize-vertical:before{content:"\e119"}.glyphicon-resize-horizontal:before{content:"\e120"}.glyphicon-hdd:before{content:"\e121"}.glyphicon-bullhorn:before{content:"\e122"}.glyphicon-bell:before{content:"\e123"}.glyphicon-certificate:before{content:"\e124"}.glyphicon-thumbs-up:before{content:"\e125"}.glyphicon-thumbs-down:before{content:"\e126"}.glyphicon-hand-right:before{content:"\e127"}.glyphicon-hand-left:before{content:"\e128"}.glyphicon-hand-up:before{content:"\e129"}.glyphicon-hand-down:before{content:"\e130"}.glyphicon-circle-arrow-right:before{content:"\e131"}.glyphicon-circle-arrow-left:before{content:"\e132"}.glyphicon-circle-arrow-up:before{content:"\e133"}.glyphicon-circle-arrow-down:before{content:"\e134"}.glyphicon-globe:before{content:"\e135"}.glyphicon-wrench:before{content:"\e136"}.glyphicon-tasks:before{content:"\e137"}.glyphicon-filter:before{content:"\e138"}.glyphicon-briefcase:before{content:"\e139"}.glyphicon-fullscreen:before{content:"\e140"}.glyphicon-dashboard:before{content:"\e141"}.glyphicon-paperclip:before{content:"\e142"}.glyphicon-heart-empty:before{content:"\e143"}.glyphicon-link:before{content:"\e144"}.glyphicon-phone:before{content:"\e145"}.glyphicon-pushpin:before{content:"\e146"}.glyphicon-usd:before{content:"\e148"}.glyphicon-gbp:before{content:"\e149"}.glyphicon-sort:before{content:"\e150"}.glyphicon-sort-by-alphabet:before{content:"\e151"}.glyphicon-sort-by-alphabet-alt:before{content:"\e152"}.glyphicon-sort-by-order:before{content:"\e153"}.glyphicon-sort-by-order-alt:before{content:"\e154"}.glyphicon-sort-by-attributes:before{content:"\e155"}.glyphicon-sort-by-attributes-alt:before{content:"\e156"}.glyphicon-unchecked:before{content:"\e157"}.glyphicon-expand:before{content:"\e158"}.glyphicon-collapse-down:before{content:"\e159"}.glyphicon-collapse-up:before{content:"\e160"}.glyphicon-log-in:before{content:"\e161"}.glyphicon-flash:before{content:"\e162"}.glyphicon-log-out:before{content:"\e163"}.glyphicon-new-window:before{content:"\e164"}.glyphicon-record:before{content:"\e165"}.glyphicon-save:before{content:"\e166"}.glyphicon-open:before{content:"\e167"}.glyphicon-saved:before{content:"\e168"}.glyphicon-import:before{content:"\e169"}.glyphicon-export:before{content:"\e170"}.glyphicon-send:before{content:"\e171"}.glyphicon-floppy-disk:before{content:"\e172"}.glyphicon-floppy-saved:before{content:"\e173"}.glyphicon-floppy-remove:before{content:"\e174"}.glyphicon-floppy-save:before{content:"\e175"}.glyphicon-floppy-open:before{content:"\e176"}.glyphicon-credit-card:before{content:"\e177"}.glyphicon-transfer:before{content:"\e178"}.glyphicon-cutlery:before{content:"\e179"}.glyphicon-header:before{content:"\e180"}.glyphicon-compressed:before{content:"\e181"}.glyphicon-earphone:before{content:"\e182"}.glyphicon-phone-alt:before{content:"\e183"}.glyphicon-tower:before{content:"\e184"}.glyphicon-stats:before{content:"\e185"}.glyphicon-sd-video:before{content:"\e186"}.glyphicon-hd-video:before{content:"\e187"}.glyphicon-subtitles:before{content:"\e188"}.glyphicon-sound-stereo:before{content:"\e189"}.glyphicon-sound-dolby:before{content:"\e190"}.glyphicon-sound-5-1:before{content:"\e191"}.glyphicon-sound-6-1:before{content:"\e192"}.glyphicon-sound-7-1:before{content:"\e193"}.glyphicon-copyright-mark:before{content:"\e194"}.glyphicon-registration-mark:before{content:"\e195"}.glyphicon-cloud-download:before{content:"\e197"}.glyphicon-cloud-upload:before{content:"\e198"}.glyphicon-tree-conifer:before{content:"\e199"}.glyphicon-tree-deciduous:before{content:"\e200"}.glyphicon-cd:before{content:"\e201"}.glyphicon-save-file:before{content:"\e202"}.glyphicon-open-file:before{content:"\e203"}.glyphicon-level-up:before{content:"\e204"}.glyphicon-copy:before{content:"\e205"}.glyphicon-paste:before{content:"\e206"}.glyphicon-alert:before{content:"\e209"}.glyphicon-equalizer:before{content:"\e210"}.glyphicon-king:before{content:"\e211"}.glyphicon-queen:before{content:"\e212"}.glyphicon-pawn:before{content:"\e213"}.glyphicon-bishop:before{content:"\e214"}.glyphicon-knight:before{content:"\e215"}.glyphicon-baby-formula:before{content:"\e216"}.glyphicon-tent:before{content:"\26fa"}.glyphicon-blackboard:before{content:"\e218"}.glyphicon-bed:before{content:"\e219"}.glyphicon-apple:before{content:"\f8ff"}.glyphicon-erase:before{content:"\e221"}.glyphicon-hourglass:before{content:"\231b"}.glyphicon-lamp:before{content:"\e223"}.glyphicon-duplicate:before{content:"\e224"}.glyphicon-piggy-bank:before{content:"\e225"}.glyphicon-scissors:before{content:"\e226"}.glyphicon-bitcoin:before{content:"\e227"}.glyphicon-btc:before{content:"\e227"}.glyphicon-xbt:before{content:"\e227"}.glyphicon-yen:before{content:"\00a5"}.glyphicon-jpy:before{content:"\00a5"}.glyphicon-ruble:before{content:"\20bd"}.glyphicon-rub:before{content:"\20bd"}.glyphicon-scale:before{content:"\e230"}.glyphicon-ice-lolly:before{content:"\e231"}.glyphicon-ice-lolly-tasted:before{content:"\e232"}.glyphicon-education:before{content:"\e233"}.glyphicon-option-horizontal:before{content:"\e234"}.glyphicon-option-vertical:before{content:"\e235"}.glyphicon-menu-hamburger:before{content:"\e236"}.glyphicon-modal-window:before{content:"\e237"}.glyphicon-oil:before{content:"\e238"}.glyphicon-grain:before{content:"\e239"}.glyphicon-sunglasses:before{content:"\e240"}.glyphicon-text-size:before{content:"\e241"}.glyphicon-text-color:before{content:"\e242"}.glyphicon-text-background:before{content:"\e243"}.glyphicon-object-align-top:before{content:"\e244"}.glyphicon-object-align-bottom:before{content:"\e245"}.glyphicon-object-align-horizontal:before{content:"\e246"}.glyphicon-object-align-left:before{content:"\e247"}.glyphicon-object-align-vertical:before{content:"\e248"}.glyphicon-object-align-right:before{content:"\e249"}.glyphicon-triangle-right:before{content:"\e250"}.glyphicon-triangle-left:before{content:"\e251"}.glyphicon-triangle-bottom:before{content:"\e252"}.glyphicon-triangle-top:before{content:"\e253"}.glyphicon-console:before{content:"\e254"}.glyphicon-superscript:before{content:"\e255"}.glyphicon-subscript:before{content:"\e256"}.glyphicon-menu-left:before{content:"\e257"}.glyphicon-menu-right:before{content:"\e258"}.glyphicon-menu-down:before{content:"\e259"}.glyphicon-menu-up:before{content:"\e260"}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}:after,:before{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:10px;-webkit-tap-highlight-color:rgba(0,0,0,0)}body{font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-size:14px;line-height:1.42857143;color:#333;background-color:#fff}button,input,select,textarea{font-family:inherit;font-size:inherit;line-height:inherit}a{color:#337ab7;text-decoration:none}a:focus,a:hover{color:#23527c;text-decoration:underline}a:focus{outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}figure{margin:0}img{vertical-align:middle}.carousel-inner>.item>a>img,.carousel-inner>.item>img,.img-responsive,.thumbnail a>img,.thumbnail>img{display:block;max-width:100%;height:auto}.img-rounded{border-radius:6px}.img-thumbnail{display:inline-block;max-width:100%;height:auto;padding:4px;line-height:1.42857143;background-color:#fff;border:1px solid #ddd;border-radius:4px;-webkit-transition:all .2s ease-in-out;-o-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.img-circle{border-radius:50%}hr{margin-top:20px;margin-bottom:20px;border:0;border-top:1px solid #eee}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}[role=button]{cursor:pointer}.h1,.h2,.h3,.h4,.h5,.h6,h1,h2,h3,h4,h5,h6{font-family:inherit;font-weight:500;line-height:1.1;color:inherit}.h1 .small,.h1 small,.h2 .small,.h2 small,.h3 .small,.h3 small,.h4 .small,.h4 small,.h5 .small,.h5 small,.h6 .small,.h6 small,h1 .small,h1 small,h2 .small,h2 small,h3 .small,h3 small,h4 .small,h4 small,h5 .small,h5 small,h6 .small,h6 small{font-weight:400;line-height:1;color:#777}.h1,.h2,.h3,h1,h2,h3{margin-top:20px;margin-bottom:10px}.h1 .small,.h1 small,.h2 .small,.h2 small,.h3 .small,.h3 small,h1 .small,h1 small,h2 .small,h2 small,h3 .small,h3 small{font-size:65%}.h4,.h5,.h6,h4,h5,h6{margin-top:10px;margin-bottom:10px}.h4 .small,.h4 small,.h5 .small,.h5 small,.h6 .small,.h6 small,h4 .small,h4 small,h5 .small,h5 small,h6 .small,h6 small{font-size:75%}.h1,h1{font-size:36px}.h2,h2{font-size:30px}.h3,h3{font-size:24px}.h4,h4{font-size:18px}.h5,h5{font-size:14px}.h6,h6{font-size:12px}p{margin:0 0 10px}.lead{margin-bottom:20px;font-size:16px;font-weight:300;line-height:1.4}@media (min-width:768px){.lead{font-size:21px}}.small,small{font-size:85%}.mark,mark{padding:.2em;background-color:#fcf8e3}.text-left{text-align:left}.text-right{text-align:right}.text-center{text-align:center}.text-justify{text-align:justify}.text-nowrap{white-space:nowrap}.text-lowercase{text-transform:lowercase}.text-uppercase{text-transform:uppercase}.text-capitalize{text-transform:capitalize}.text-muted{color:#777}.text-primary{color:#337ab7}a.text-primary:focus,a.text-primary:hover{color:#286090}.text-success{color:#3c763d}a.text-success:focus,a.text-success:hover{color:#2b542c}.text-info{color:#31708f}a.text-info:focus,a.text-info:hover{color:#245269}.text-warning{color:#8a6d3b}a.text-warning:focus,a.text-warning:hover{color:#66512c}.text-danger{color:#a94442}a.text-danger:focus,a.text-danger:hover{color:#843534}.bg-primary{color:#fff;background-color:#337ab7}a.bg-primary:focus,a.bg-primary:hover{background-color:#286090}.bg-success{background-color:#dff0d8}a.bg-success:focus,a.bg-success:hover{background-color:#c1e2b3}.bg-info{background-color:#d9edf7}a.bg-info:focus,a.bg-info:hover{background-color:#afd9ee}.bg-warning{background-color:#fcf8e3}a.bg-warning:focus,a.bg-warning:hover{background-color:#f7ecb5}.bg-danger{background-color:#f2dede}a.bg-danger:focus,a.bg-danger:hover{background-color:#e4b9b9}.page-header{padding-bottom:9px;margin:40px 0 20px;border-bottom:1px solid #eee}ol,ul{margin-top:0;margin-bottom:10px}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}.list-unstyled{padding-left:0;list-style:none}.list-inline{padding-left:0;margin-left:-5px;list-style:none}.list-inline>li{display:inline-block;padding-right:5px;padding-left:5px}dl{margin-top:0;margin-bottom:20px}dd,dt{line-height:1.42857143}dt{font-weight:700}dd{margin-left:0}@media (min-width:768px){.dl-horizontal dt{float:left;width:160px;overflow:hidden;clear:left;text-align:right;text-overflow:ellipsis;white-space:nowrap}.dl-horizontal dd{margin-left:180px}}abbr[data-original-title],abbr[title]{cursor:help;border-bottom:1px dotted #777}.initialism{font-size:90%;text-transform:uppercase}blockquote{padding:10px 20px;margin:0 0 20px;font-size:17.5px;border-left:5px solid #eee}blockquote ol:last-child,blockquote p:last-child,blockquote ul:last-child{margin-bottom:0}blockquote .small,blockquote footer,blockquote small{display:block;font-size:80%;line-height:1.42857143;color:#777}blockquote .small:before,blockquote footer:before,blockquote small:before{content:'\2014 \00A0'}.blockquote-reverse,blockquote.pull-right{padding-right:15px;padding-left:0;text-align:right;border-right:5px solid #eee;border-left:0}.blockquote-reverse .small:before,.blockquote-reverse footer:before,.blockquote-reverse small:before,blockquote.pull-right .small:before,blockquote.pull-right footer:before,blockquote.pull-right small:before{content:''}.blockquote-reverse .small:after,.blockquote-reverse footer:after,.blockquote-reverse small:after,blockquote.pull-right .small:after,blockquote.pull-right footer:after,blockquote.pull-right small:after{content:'\00A0 \2014'}address{margin-bottom:20px;font-style:normal;line-height:1.42857143}code,kbd,pre,samp{font-family:Menlo,Monaco,Consolas,"Courier New",monospace}code{padding:2px 4px;font-size:90%;color:#c7254e;background-color:#f9f2f4;border-radius:4px}kbd{padding:2px 4px;font-size:90%;color:#fff;background-color:#333;border-radius:3px;-webkit-box-shadow:inset 0 -1px 0 rgba(0,0,0,.25);box-shadow:inset 0 -1px 0 rgba(0,0,0,.25)}kbd kbd{padding:0;font-size:100%;font-weight:700;-webkit-box-shadow:none;box-shadow:none}pre{display:block;padding:9.5px;margin:0 0 10px;font-size:13px;line-height:1.42857143;color:#333;word-break:break-all;word-wrap:break-word;background-color:#f5f5f5;border:1px solid #ccc;border-radius:4px}pre code{padding:0;font-size:inherit;color:inherit;white-space:pre-wrap;background-color:transparent;border-radius:0}.pre-scrollable{max-height:340px;overflow-y:scroll}.container{padding-right:15px;padding-left:15px;margin-right:auto;margin-left:auto}@media (min-width:768px){.container{width:750px}}@media (min-width:992px){.container{width:970px}}@media (min-width:1200px){.container{width:1170px}}.container-fluid{padding-right:15px;padding-left:15px;margin-right:auto;margin-left:auto}.row{margin-right:-15px;margin-left:-15px}.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-xs-1,.col-xs-10,.col-xs-11,.col-xs-12,.col-xs-2,.col-xs-3,.col-xs-4,.col-xs-5,.col-xs-6,.col-xs-7,.col-xs-8,.col-xs-9{position:relative;min-height:1px;padding-right:15px;padding-left:15px}.col-xs-1,.col-xs-10,.col-xs-11,.col-xs-12,.col-xs-2,.col-xs-3,.col-xs-4,.col-xs-5,.col-xs-6,.col-xs-7,.col-xs-8,.col-xs-9{float:left}.col-xs-12{width:100%}.col-xs-11{width:91.66666667%}.col-xs-10{width:83.33333333%}.col-xs-9{width:75%}.col-xs-8{width:66.66666667%}.col-xs-7{width:58.33333333%}.col-xs-6{width:50%}.col-xs-5{width:41.66666667%}.col-xs-4{width:33.33333333%}.col-xs-3{width:25%}.col-xs-2{width:16.66666667%}.col-xs-1{width:8.33333333%}.col-xs-pull-12{right:100%}.col-xs-pull-11{right:91.66666667%}.col-xs-pull-10{right:83.33333333%}.col-xs-pull-9{right:75%}.col-xs-pull-8{right:66.66666667%}.col-xs-pull-7{right:58.33333333%}.col-xs-pull-6{right:50%}.col-xs-pull-5{right:41.66666667%}.col-xs-pull-4{right:33.33333333%}.col-xs-pull-3{right:25%}.col-xs-pull-2{right:16.66666667%}.col-xs-pull-1{right:8.33333333%}.col-xs-pull-0{right:auto}.col-xs-push-12{left:100%}.col-xs-push-11{left:91.66666667%}.col-xs-push-10{left:83.33333333%}.col-xs-push-9{left:75%}.col-xs-push-8{left:66.66666667%}.col-xs-push-7{left:58.33333333%}.col-xs-push-6{left:50%}.col-xs-push-5{left:41.66666667%}.col-xs-push-4{left:33.33333333%}.col-xs-push-3{left:25%}.col-xs-push-2{left:16.66666667%}.col-xs-push-1{left:8.33333333%}.col-xs-push-0{left:auto}.col-xs-offset-12{margin-left:100%}.col-xs-offset-11{margin-left:91.66666667%}.col-xs-offset-10{margin-left:83.33333333%}.col-xs-offset-9{margin-left:75%}.col-xs-offset-8{margin-left:66.66666667%}.col-xs-offset-7{margin-left:58.33333333%}.col-xs-offset-6{margin-left:50%}.col-xs-offset-5{margin-left:41.66666667%}.col-xs-offset-4{margin-left:33.33333333%}.col-xs-offset-3{margin-left:25%}.col-xs-offset-2{margin-left:16.66666667%}.col-xs-offset-1{margin-left:8.33333333%}.col-xs-offset-0{margin-left:0}@media (min-width:768px){.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9{float:left}.col-sm-12{width:100%}.col-sm-11{width:91.66666667%}.col-sm-10{width:83.33333333%}.col-sm-9{width:75%}.col-sm-8{width:66.66666667%}.col-sm-7{width:58.33333333%}.col-sm-6{width:50%}.col-sm-5{width:41.66666667%}.col-sm-4{width:33.33333333%}.col-sm-3{width:25%}.col-sm-2{width:16.66666667%}.col-sm-1{width:8.33333333%}.col-sm-pull-12{right:100%}.col-sm-pull-11{right:91.66666667%}.col-sm-pull-10{right:83.33333333%}.col-sm-pull-9{right:75%}.col-sm-pull-8{right:66.66666667%}.col-sm-pull-7{right:58.33333333%}.col-sm-pull-6{right:50%}.col-sm-pull-5{right:41.66666667%}.col-sm-pull-4{right:33.33333333%}.col-sm-pull-3{right:25%}.col-sm-pull-2{right:16.66666667%}.col-sm-pull-1{right:8.33333333%}.col-sm-pull-0{right:auto}.col-sm-push-12{left:100%}.col-sm-push-11{left:91.66666667%}.col-sm-push-10{left:83.33333333%}.col-sm-push-9{left:75%}.col-sm-push-8{left:66.66666667%}.col-sm-push-7{left:58.33333333%}.col-sm-push-6{left:50%}.col-sm-push-5{left:41.66666667%}.col-sm-push-4{left:33.33333333%}.col-sm-push-3{left:25%}.col-sm-push-2{left:16.66666667%}.col-sm-push-1{left:8.33333333%}.col-sm-push-0{left:auto}.col-sm-offset-12{margin-left:100%}.col-sm-offset-11{margin-left:91.66666667%}.col-sm-offset-10{margin-left:83.33333333%}.col-sm-offset-9{margin-left:75%}.col-sm-offset-8{margin-left:66.66666667%}.col-sm-offset-7{margin-left:58.33333333%}.col-sm-offset-6{margin-left:50%}.col-sm-offset-5{margin-left:41.66666667%}.col-sm-offset-4{margin-left:33.33333333%}.col-sm-offset-3{margin-left:25%}.col-sm-offset-2{margin-left:16.66666667%}.col-sm-offset-1{margin-left:8.33333333%}.col-sm-offset-0{margin-left:0}}@media (min-width:992px){.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9{float:left}.col-md-12{width:100%}.col-md-11{width:91.66666667%}.col-md-10{width:83.33333333%}.col-md-9{width:75%}.col-md-8{width:66.66666667%}.col-md-7{width:58.33333333%}.col-md-6{width:50%}.col-md-5{width:41.66666667%}.col-md-4{width:33.33333333%}.col-md-3{width:25%}.col-md-2{width:16.66666667%}.col-md-1{width:8.33333333%}.col-md-pull-12{right:100%}.col-md-pull-11{right:91.66666667%}.col-md-pull-10{right:83.33333333%}.col-md-pull-9{right:75%}.col-md-pull-8{right:66.66666667%}.col-md-pull-7{right:58.33333333%}.col-md-pull-6{right:50%}.col-md-pull-5{right:41.66666667%}.col-md-pull-4{right:33.33333333%}.col-md-pull-3{right:25%}.col-md-pull-2{right:16.66666667%}.col-md-pull-1{right:8.33333333%}.col-md-pull-0{right:auto}.col-md-push-12{left:100%}.col-md-push-11{left:91.66666667%}.col-md-push-10{left:83.33333333%}.col-md-push-9{left:75%}.col-md-push-8{left:66.66666667%}.col-md-push-7{left:58.33333333%}.col-md-push-6{left:50%}.col-md-push-5{left:41.66666667%}.col-md-push-4{left:33.33333333%}.col-md-push-3{left:25%}.col-md-push-2{left:16.66666667%}.col-md-push-1{left:8.33333333%}.col-md-push-0{left:auto}.col-md-offset-12{margin-left:100%}.col-md-offset-11{margin-left:91.66666667%}.col-md-offset-10{margin-left:83.33333333%}.col-md-offset-9{margin-left:75%}.col-md-offset-8{margin-left:66.66666667%}.col-md-offset-7{margin-left:58.33333333%}.col-md-offset-6{margin-left:50%}.col-md-offset-5{margin-left:41.66666667%}.col-md-offset-4{margin-left:33.33333333%}.col-md-offset-3{margin-left:25%}.col-md-offset-2{margin-left:16.66666667%}.col-md-offset-1{margin-left:8.33333333%}.col-md-offset-0{margin-left:0}}@media (min-width:1200px){.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9{float:left}.col-lg-12{width:100%}.col-lg-11{width:91.66666667%}.col-lg-10{width:83.33333333%}.col-lg-9{width:75%}.col-lg-8{width:66.66666667%}.col-lg-7{width:58.33333333%}.col-lg-6{width:50%}.col-lg-5{width:41.66666667%}.col-lg-4{width:33.33333333%}.col-lg-3{width:25%}.col-lg-2{width:16.66666667%}.col-lg-1{width:8.33333333%}.col-lg-pull-12{right:100%}.col-lg-pull-11{right:91.66666667%}.col-lg-pull-10{right:83.33333333%}.col-lg-pull-9{right:75%}.col-lg-pull-8{right:66.66666667%}.col-lg-pull-7{right:58.33333333%}.col-lg-pull-6{right:50%}.col-lg-pull-5{right:41.66666667%}.col-lg-pull-4{right:33.33333333%}.col-lg-pull-3{right:25%}.col-lg-pull-2{right:16.66666667%}.col-lg-pull-1{right:8.33333333%}.col-lg-pull-0{right:auto}.col-lg-push-12{left:100%}.col-lg-push-11{left:91.66666667%}.col-lg-push-10{left:83.33333333%}.col-lg-push-9{left:75%}.col-lg-push-8{left:66.66666667%}.col-lg-push-7{left:58.33333333%}.col-lg-push-6{left:50%}.col-lg-push-5{left:41.66666667%}.col-lg-push-4{left:33.33333333%}.col-lg-push-3{left:25%}.col-lg-push-2{left:16.66666667%}.col-lg-push-1{left:8.33333333%}.col-lg-push-0{left:auto}.col-lg-offset-12{margin-left:100%}.col-lg-offset-11{margin-left:91.66666667%}.col-lg-offset-10{margin-left:83.33333333%}.col-lg-offset-9{margin-left:75%}.col-lg-offset-8{margin-left:66.66666667%}.col-lg-offset-7{margin-left:58.33333333%}.col-lg-offset-6{margin-left:50%}.col-lg-offset-5{margin-left:41.66666667%}.col-lg-offset-4{margin-left:33.33333333%}.col-lg-offset-3{margin-left:25%}.col-lg-offset-2{margin-left:16.66666667%}.col-lg-offset-1{margin-left:8.33333333%}.col-lg-offset-0{margin-left:0}}table{background-color:transparent}caption{padding-top:8px;padding-bottom:8px;color:#777;text-align:left}th{text-align:left}.table{width:100%;max-width:100%;margin-bottom:20px}.table>tbody>tr>td,.table>tbody>tr>th,.table>tfoot>tr>td,.table>tfoot>tr>th,.table>thead>tr>td,.table>thead>tr>th{padding:8px;line-height:1.42857143;vertical-align:top;border-top:1px solid #ddd}.table>thead>tr>th{vertical-align:bottom;border-bottom:2px solid #ddd}.table>caption+thead>tr:first-child>td,.table>caption+thead>tr:first-child>th,.table>colgroup+thead>tr:first-child>td,.table>colgroup+thead>tr:first-child>th,.table>thead:first-child>tr:first-child>td,.table>thead:first-child>tr:first-child>th{border-top:0}.table>tbody+tbody{border-top:2px solid #ddd}.table .table{background-color:#fff}.table-condensed>tbody>tr>td,.table-condensed>tbody>tr>th,.table-condensed>tfoot>tr>td,.table-condensed>tfoot>tr>th,.table-condensed>thead>tr>td,.table-condensed>thead>tr>th{padding:5px}.table-bordered{border:1px solid #ddd}.table-bordered>tbody>tr>td,.table-bordered>tbody>tr>th,.table-bordered>tfoot>tr>td,.table-bordered>tfoot>tr>th,.table-bordered>thead>tr>td,.table-bordered>thead>tr>th{border:1px solid #ddd}.table-bordered>thead>tr>td,.table-bordered>thead>tr>th{border-bottom-width:2px}.table-striped>tbody>tr:nth-of-type(odd){background-color:#f9f9f9}.table-hover>tbody>tr:hover{background-color:#f5f5f5}table col[class*=col-]{position:static;display:table-column;float:none}table td[class*=col-],table th[class*=col-]{position:static;display:table-cell;float:none}.table>tbody>tr.active>td,.table>tbody>tr.active>th,.table>tbody>tr>td.active,.table>tbody>tr>th.active,.table>tfoot>tr.active>td,.table>tfoot>tr.active>th,.table>tfoot>tr>td.active,.table>tfoot>tr>th.active,.table>thead>tr.active>td,.table>thead>tr.active>th,.table>thead>tr>td.active,.table>thead>tr>th.active{background-color:#f5f5f5}.table-hover>tbody>tr.active:hover>td,.table-hover>tbody>tr.active:hover>th,.table-hover>tbody>tr:hover>.active,.table-hover>tbody>tr>td.active:hover,.table-hover>tbody>tr>th.active:hover{background-color:#e8e8e8}.table>tbody>tr.success>td,.table>tbody>tr.success>th,.table>tbody>tr>td.success,.table>tbody>tr>th.success,.table>tfoot>tr.success>td,.table>tfoot>tr.success>th,.table>tfoot>tr>td.success,.table>tfoot>tr>th.success,.table>thead>tr.success>td,.table>thead>tr.success>th,.table>thead>tr>td.success,.table>thead>tr>th.success{background-color:#dff0d8}.table-hover>tbody>tr.success:hover>td,.table-hover>tbody>tr.success:hover>th,.table-hover>tbody>tr:hover>.success,.table-hover>tbody>tr>td.success:hover,.table-hover>tbody>tr>th.success:hover{background-color:#d0e9c6}.table>tbody>tr.info>td,.table>tbody>tr.info>th,.table>tbody>tr>td.info,.table>tbody>tr>th.info,.table>tfoot>tr.info>td,.table>tfoot>tr.info>th,.table>tfoot>tr>td.info,.table>tfoot>tr>th.info,.table>thead>tr.info>td,.table>thead>tr.info>th,.table>thead>tr>td.info,.table>thead>tr>th.info{background-color:#d9edf7}.table-hover>tbody>tr.info:hover>td,.table-hover>tbody>tr.info:hover>th,.table-hover>tbody>tr:hover>.info,.table-hover>tbody>tr>td.info:hover,.table-hover>tbody>tr>th.info:hover{background-color:#c4e3f3}.table>tbody>tr.warning>td,.table>tbody>tr.warning>th,.table>tbody>tr>td.warning,.table>tbody>tr>th.warning,.table>tfoot>tr.warning>td,.table>tfoot>tr.warning>th,.table>tfoot>tr>td.warning,.table>tfoot>tr>th.warning,.table>thead>tr.warning>td,.table>thead>tr.warning>th,.table>thead>tr>td.warning,.table>thead>tr>th.warning{background-color:#fcf8e3}.table-hover>tbody>tr.warning:hover>td,.table-hover>tbody>tr.warning:hover>th,.table-hover>tbody>tr:hover>.warning,.table-hover>tbody>tr>td.warning:hover,.table-hover>tbody>tr>th.warning:hover{background-color:#faf2cc}.table>tbody>tr.danger>td,.table>tbody>tr.danger>th,.table>tbody>tr>td.danger,.table>tbody>tr>th.danger,.table>tfoot>tr.danger>td,.table>tfoot>tr.danger>th,.table>tfoot>tr>td.danger,.table>tfoot>tr>th.danger,.table>thead>tr.danger>td,.table>thead>tr.danger>th,.table>thead>tr>td.danger,.table>thead>tr>th.danger{background-color:#f2dede}.table-hover>tbody>tr.danger:hover>td,.table-hover>tbody>tr.danger:hover>th,.table-hover>tbody>tr:hover>.danger,.table-hover>tbody>tr>td.danger:hover,.table-hover>tbody>tr>th.danger:hover{background-color:#ebcccc}.table-responsive{min-height:.01%;overflow-x:auto}@media screen and (max-width:767px){.table-responsive{width:100%;margin-bottom:15px;overflow-y:hidden;-ms-overflow-style:-ms-autohiding-scrollbar;border:1px solid #ddd}.table-responsive>.table{margin-bottom:0}.table-responsive>.table>tbody>tr>td,.table-responsive>.table>tbody>tr>th,.table-responsive>.table>tfoot>tr>td,.table-responsive>.table>tfoot>tr>th,.table-responsive>.table>thead>tr>td,.table-responsive>.table>thead>tr>th{white-space:nowrap}.table-responsive>.table-bordered{border:0}.table-responsive>.table-bordered>tbody>tr>td:first-child,.table-responsive>.table-bordered>tbody>tr>th:first-child,.table-responsive>.table-bordered>tfoot>tr>td:first-child,.table-responsive>.table-bordered>tfoot>tr>th:first-child,.table-responsive>.table-bordered>thead>tr>td:first-child,.table-responsive>.table-bordered>thead>tr>th:first-child{border-left:0}.table-responsive>.table-bordered>tbody>tr>td:last-child,.table-responsive>.table-bordered>tbody>tr>th:last-child,.table-responsive>.table-bordered>tfoot>tr>td:last-child,.table-responsive>.table-bordered>tfoot>tr>th:last-child,.table-responsive>.table-bordered>thead>tr>td:last-child,.table-responsive>.table-bordered>thead>tr>th:last-child{border-right:0}.table-responsive>.table-bordered>tbody>tr:last-child>td,.table-responsive>.table-bordered>tbody>tr:last-child>th,.table-responsive>.table-bordered>tfoot>tr:last-child>td,.table-responsive>.table-bordered>tfoot>tr:last-child>th{border-bottom:0}}fieldset{min-width:0;padding:0;margin:0;border:0}legend{display:block;width:100%;padding:0;margin-bottom:20px;font-size:21px;line-height:inherit;color:#333;border:0;border-bottom:1px solid #e5e5e5}label{display:inline-block;max-width:100%;margin-bottom:5px;font-weight:700}input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=checkbox],input[type=radio]{margin:4px 0 0;margin-top:1px\9;line-height:normal}input[type=file]{display:block}input[type=range]{display:block;width:100%}select[multiple],select[size]{height:auto}input[type=file]:focus,input[type=checkbox]:focus,input[type=radio]:focus{outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}output{display:block;padding-top:7px;font-size:14px;line-height:1.42857143;color:#555}.form-control{display:block;width:100%;height:34px;padding:6px 12px;font-size:14px;line-height:1.42857143;color:#555;background-color:#fff;background-image:none;border:1px solid #ccc;border-radius:4px;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075);box-shadow:inset 0 1px 1px rgba(0,0,0,.075);-webkit-transition:border-color ease-in-out .15s,-webkit-box-shadow ease-in-out .15s;-o-transition:border-color ease-in-out .15s,box-shadow ease-in-out .15s;transition:border-color ease-in-out .15s,box-shadow ease-in-out .15s}.form-control:focus{border-color:#66afe9;outline:0;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 8px rgba(102,175,233,.6);box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 8px rgba(102,175,233,.6)}.form-control::-moz-placeholder{color:#999;opacity:1}.form-control:-ms-input-placeholder{color:#999}.form-control::-webkit-input-placeholder{color:#999}.form-control::-ms-expand{background-color:transparent;border:0}.form-control[disabled],.form-control[readonly],fieldset[disabled] .form-control{background-color:#eee;opacity:1}.form-control[disabled],fieldset[disabled] .form-control{cursor:not-allowed}textarea.form-control{height:auto}input[type=search]{-webkit-appearance:none}@media screen and (-webkit-min-device-pixel-ratio:0){input[type=date].form-control,input[type=time].form-control,input[type=datetime-local].form-control,input[type=month].form-control{line-height:34px}.input-group-sm input[type=date],.input-group-sm input[type=time],.input-group-sm input[type=datetime-local],.input-group-sm input[type=month],input[type=date].input-sm,input[type=time].input-sm,input[type=datetime-local].input-sm,input[type=month].input-sm{line-height:30px}.input-group-lg input[type=date],.input-group-lg input[type=time],.input-group-lg input[type=datetime-local],.input-group-lg input[type=month],input[type=date].input-lg,input[type=time].input-lg,input[type=datetime-local].input-lg,input[type=month].input-lg{line-height:46px}}.form-group{margin-bottom:15px}.checkbox,.radio{position:relative;display:block;margin-top:10px;margin-bottom:10px}.checkbox label,.radio label{min-height:20px;padding-left:20px;margin-bottom:0;font-weight:400;cursor:pointer}.checkbox input[type=checkbox],.checkbox-inline input[type=checkbox],.radio input[type=radio],.radio-inline input[type=radio]{position:absolute;margin-top:4px\9;margin-left:-20px}.checkbox+.checkbox,.radio+.radio{margin-top:-5px}.checkbox-inline,.radio-inline{position:relative;display:inline-block;padding-left:20px;margin-bottom:0;font-weight:400;vertical-align:middle;cursor:pointer}.checkbox-inline+.checkbox-inline,.radio-inline+.radio-inline{margin-top:0;margin-left:10px}fieldset[disabled] input[type=checkbox],fieldset[disabled] input[type=radio],input[type=checkbox].disabled,input[type=checkbox][disabled],input[type=radio].disabled,input[type=radio][disabled]{cursor:not-allowed}.checkbox-inline.disabled,.radio-inline.disabled,fieldset[disabled] .checkbox-inline,fieldset[disabled] .radio-inline{cursor:not-allowed}.checkbox.disabled label,.radio.disabled label,fieldset[disabled] .checkbox label,fieldset[disabled] .radio label{cursor:not-allowed}.form-control-static{min-height:34px;padding-top:7px;padding-bottom:7px;margin-bottom:0}.form-control-static.input-lg,.form-control-static.input-sm{padding-right:0;padding-left:0}.input-sm{height:30px;padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}select.input-sm{height:30px;line-height:30px}select[multiple].input-sm,textarea.input-sm{height:auto}.form-group-sm .form-control{height:30px;padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}.form-group-sm select.form-control{height:30px;line-height:30px}.form-group-sm select[multiple].form-control,.form-group-sm textarea.form-control{height:auto}.form-group-sm .form-control-static{height:30px;min-height:32px;padding:6px 10px;font-size:12px;line-height:1.5}.input-lg{height:46px;padding:10px 16px;font-size:18px;line-height:1.3333333;border-radius:6px}select.input-lg{height:46px;line-height:46px}select[multiple].input-lg,textarea.input-lg{height:auto}.form-group-lg .form-control{height:46px;padding:10px 16px;font-size:18px;line-height:1.3333333;border-radius:6px}.form-group-lg select.form-control{height:46px;line-height:46px}.form-group-lg select[multiple].form-control,.form-group-lg textarea.form-control{height:auto}.form-group-lg .form-control-static{height:46px;min-height:38px;padding:11px 16px;font-size:18px;line-height:1.3333333}.has-feedback{position:relative}.has-feedback .form-control{padding-right:42.5px}.form-control-feedback{position:absolute;top:0;right:0;z-index:2;display:block;width:34px;height:34px;line-height:34px;text-align:center;pointer-events:none}.form-group-lg .form-control+.form-control-feedback,.input-group-lg+.form-control-feedback,.input-lg+.form-control-feedback{width:46px;height:46px;line-height:46px}.form-group-sm .form-control+.form-control-feedback,.input-group-sm+.form-control-feedback,.input-sm+.form-control-feedback{width:30px;height:30px;line-height:30px}.has-success .checkbox,.has-success .checkbox-inline,.has-success .control-label,.has-success .help-block,.has-success .radio,.has-success .radio-inline,.has-success.checkbox label,.has-success.checkbox-inline label,.has-success.radio label,.has-success.radio-inline label{color:#3c763d}.has-success .form-control{border-color:#3c763d;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075);box-shadow:inset 0 1px 1px rgba(0,0,0,.075)}.has-success .form-control:focus{border-color:#2b542c;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #67b168;box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #67b168}.has-success .input-group-addon{color:#3c763d;background-color:#dff0d8;border-color:#3c763d}.has-success .form-control-feedback{color:#3c763d}.has-warning .checkbox,.has-warning .checkbox-inline,.has-warning .control-label,.has-warning .help-block,.has-warning .radio,.has-warning .radio-inline,.has-warning.checkbox label,.has-warning.checkbox-inline label,.has-warning.radio label,.has-warning.radio-inline label{color:#8a6d3b}.has-warning .form-control{border-color:#8a6d3b;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075);box-shadow:inset 0 1px 1px rgba(0,0,0,.075)}.has-warning .form-control:focus{border-color:#66512c;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #c0a16b;box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #c0a16b}.has-warning .input-group-addon{color:#8a6d3b;background-color:#fcf8e3;border-color:#8a6d3b}.has-warning .form-control-feedback{color:#8a6d3b}.has-error .checkbox,.has-error .checkbox-inline,.has-error .control-label,.has-error .help-block,.has-error .radio,.has-error .radio-inline,.has-error.checkbox label,.has-error.checkbox-inline label,.has-error.radio label,.has-error.radio-inline label{color:#a94442}.has-error .form-control{border-color:#a94442;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075);box-shadow:inset 0 1px 1px rgba(0,0,0,.075)}.has-error .form-control:focus{border-color:#843534;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #ce8483;box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #ce8483}.has-error .input-group-addon{color:#a94442;background-color:#f2dede;border-color:#a94442}.has-error .form-control-feedback{color:#a94442}.has-feedback label~.form-control-feedback{top:25px}.has-feedback label.sr-only~.form-control-feedback{top:0}.help-block{display:block;margin-top:5px;margin-bottom:10px;color:#737373}@media (min-width:768px){.form-inline .form-group{display:inline-block;margin-bottom:0;vertical-align:middle}.form-inline .form-control{display:inline-block;width:auto;vertical-align:middle}.form-inline .form-control-static{display:inline-block}.form-inline .input-group{display:inline-table;vertical-align:middle}.form-inline .input-group .form-control,.form-inline .input-group .input-group-addon,.form-inline .input-group .input-group-btn{width:auto}.form-inline .input-group>.form-control{width:100%}.form-inline .control-label{margin-bottom:0;vertical-align:middle}.form-inline .checkbox,.form-inline .radio{display:inline-block;margin-top:0;margin-bottom:0;vertical-align:middle}.form-inline .checkbox label,.form-inline .radio label{padding-left:0}.form-inline .checkbox input[type=checkbox],.form-inline .radio input[type=radio]{position:relative;margin-left:0}.form-inline .has-feedback .form-control-feedback{top:0}}.form-horizontal .checkbox,.form-horizontal .checkbox-inline,.form-horizontal .radio,.form-horizontal .radio-inline{padding-top:7px;margin-top:0;margin-bottom:0}.form-horizontal .checkbox,.form-horizontal .radio{min-height:27px}.form-horizontal .form-group{margin-right:-15px;margin-left:-15px}@media (min-width:768px){.form-horizontal .control-label{padding-top:7px;margin-bottom:0;text-align:right}}.form-horizontal .has-feedback .form-control-feedback{right:15px}@media (min-width:768px){.form-horizontal .form-group-lg .control-label{padding-top:11px;font-size:18px}}@media (min-width:768px){.form-horizontal .form-group-sm .control-label{padding-top:6px;font-size:12px}}.btn{display:inline-block;padding:6px 12px;margin-bottom:0;font-size:14px;font-weight:400;line-height:1.42857143;text-align:center;white-space:nowrap;vertical-align:middle;-ms-touch-action:manipulation;touch-action:manipulation;cursor:pointer;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;background-image:none;border:1px solid transparent;border-radius:4px}.btn.active.focus,.btn.active:focus,.btn.focus,.btn:active.focus,.btn:active:focus,.btn:focus{outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}.btn.focus,.btn:focus,.btn:hover{color:#333;text-decoration:none}.btn.active,.btn:active{background-image:none;outline:0;-webkit-box-shadow:inset 0 3px 5px rgba(0,0,0,.125);box-shadow:inset 0 3px 5px rgba(0,0,0,.125)}.btn.disabled,.btn[disabled],fieldset[disabled] .btn{cursor:not-allowed;filter:alpha(opacity=65);-webkit-box-shadow:none;box-shadow:none;opacity:.65}a.btn.disabled,fieldset[disabled] a.btn{pointer-events:none}.btn-default{color:#333;background-color:#fff;border-color:#ccc}.btn-default.focus,.btn-default:focus{color:#333;background-color:#e6e6e6;border-color:#8c8c8c}.btn-default:hover{color:#333;background-color:#e6e6e6;border-color:#adadad}.btn-default.active,.btn-default:active,.open>.dropdown-toggle.btn-default{color:#333;background-color:#e6e6e6;border-color:#adadad}.btn-default.active.focus,.btn-default.active:focus,.btn-default.active:hover,.btn-default:active.focus,.btn-default:active:focus,.btn-default:active:hover,.open>.dropdown-toggle.btn-default.focus,.open>.dropdown-toggle.btn-default:focus,.open>.dropdown-toggle.btn-default:hover{color:#333;background-color:#d4d4d4;border-color:#8c8c8c}.btn-default.active,.btn-default:active,.open>.dropdown-toggle.btn-default{background-image:none}.btn-default.disabled.focus,.btn-default.disabled:focus,.btn-default.disabled:hover,.btn-default[disabled].focus,.btn-default[disabled]:focus,.btn-default[disabled]:hover,fieldset[disabled] .btn-default.focus,fieldset[disabled] .btn-default:focus,fieldset[disabled] .btn-default:hover{background-color:#fff;border-color:#ccc}.btn-default .badge{color:#fff;background-color:#333}.btn-primary{color:#fff;background-color:#337ab7;border-color:#2e6da4}.btn-primary.focus,.btn-primary:focus{color:#fff;background-color:#286090;border-color:#122b40}.btn-primary:hover{color:#fff;background-color:#286090;border-color:#204d74}.btn-primary.active,.btn-primary:active,.open>.dropdown-toggle.btn-primary{color:#fff;background-color:#286090;border-color:#204d74}.btn-primary.active.focus,.btn-primary.active:focus,.btn-primary.active:hover,.btn-primary:active.focus,.btn-primary:active:focus,.btn-primary:active:hover,.open>.dropdown-toggle.btn-primary.focus,.open>.dropdown-toggle.btn-primary:focus,.open>.dropdown-toggle.btn-primary:hover{color:#fff;background-color:#204d74;border-color:#122b40}.btn-primary.active,.btn-primary:active,.open>.dropdown-toggle.btn-primary{background-image:none}.btn-primary.disabled.focus,.btn-primary.disabled:focus,.btn-primary.disabled:hover,.btn-primary[disabled].focus,.btn-primary[disabled]:focus,.btn-primary[disabled]:hover,fieldset[disabled] .btn-primary.focus,fieldset[disabled] .btn-primary:focus,fieldset[disabled] .btn-primary:hover{background-color:#337ab7;border-color:#2e6da4}.btn-primary .badge{color:#337ab7;background-color:#fff}.btn-success{color:#fff;background-color:#5cb85c;border-color:#4cae4c}.btn-success.focus,.btn-success:focus{color:#fff;background-color:#449d44;border-color:#255625}.btn-success:hover{color:#fff;background-color:#449d44;border-color:#398439}.btn-success.active,.btn-success:active,.open>.dropdown-toggle.btn-success{color:#fff;background-color:#449d44;border-color:#398439}.btn-success.active.focus,.btn-success.active:focus,.btn-success.active:hover,.btn-success:active.focus,.btn-success:active:focus,.btn-success:active:hover,.open>.dropdown-toggle.btn-success.focus,.open>.dropdown-toggle.btn-success:focus,.open>.dropdown-toggle.btn-success:hover{color:#fff;background-color:#398439;border-color:#255625}.btn-success.active,.btn-success:active,.open>.dropdown-toggle.btn-success{background-image:none}.btn-success.disabled.focus,.btn-success.disabled:focus,.btn-success.disabled:hover,.btn-success[disabled].focus,.btn-success[disabled]:focus,.btn-success[disabled]:hover,fieldset[disabled] .btn-success.focus,fieldset[disabled] .btn-success:focus,fieldset[disabled] .btn-success:hover{background-color:#5cb85c;border-color:#4cae4c}.btn-success .badge{color:#5cb85c;background-color:#fff}.btn-info{color:#fff;background-color:#5bc0de;border-color:#46b8da}.btn-info.focus,.btn-info:focus{color:#fff;background-color:#31b0d5;border-color:#1b6d85}.btn-info:hover{color:#fff;background-color:#31b0d5;border-color:#269abc}.btn-info.active,.btn-info:active,.open>.dropdown-toggle.btn-info{color:#fff;background-color:#31b0d5;border-color:#269abc}.btn-info.active.focus,.btn-info.active:focus,.btn-info.active:hover,.btn-info:active.focus,.btn-info:active:focus,.btn-info:active:hover,.open>.dropdown-toggle.btn-info.focus,.open>.dropdown-toggle.btn-info:focus,.open>.dropdown-toggle.btn-info:hover{color:#fff;background-color:#269abc;border-color:#1b6d85}.btn-info.active,.btn-info:active,.open>.dropdown-toggle.btn-info{background-image:none}.btn-info.disabled.focus,.btn-info.disabled:focus,.btn-info.disabled:hover,.btn-info[disabled].focus,.btn-info[disabled]:focus,.btn-info[disabled]:hover,fieldset[disabled] .btn-info.focus,fieldset[disabled] .btn-info:focus,fieldset[disabled] .btn-info:hover{background-color:#5bc0de;border-color:#46b8da}.btn-info .badge{color:#5bc0de;background-color:#fff}.btn-warning{color:#fff;background-color:#f0ad4e;border-color:#eea236}.btn-warning.focus,.btn-warning:focus{color:#fff;background-color:#ec971f;border-color:#985f0d}.btn-warning:hover{color:#fff;background-color:#ec971f;border-color:#d58512}.btn-warning.active,.btn-warning:active,.open>.dropdown-toggle.btn-warning{color:#fff;background-color:#ec971f;border-color:#d58512}.btn-warning.active.focus,.btn-warning.active:focus,.btn-warning.active:hover,.btn-warning:active.focus,.btn-warning:active:focus,.btn-warning:active:hover,.open>.dropdown-toggle.btn-warning.focus,.open>.dropdown-toggle.btn-warning:focus,.open>.dropdown-toggle.btn-warning:hover{color:#fff;background-color:#d58512;border-color:#985f0d}.btn-warning.active,.btn-warning:active,.open>.dropdown-toggle.btn-warning{background-image:none}.btn-warning.disabled.focus,.btn-warning.disabled:focus,.btn-warning.disabled:hover,.btn-warning[disabled].focus,.btn-warning[disabled]:focus,.btn-warning[disabled]:hover,fieldset[disabled] .btn-warning.focus,fieldset[disabled] .btn-warning:focus,fieldset[disabled] .btn-warning:hover{background-color:#f0ad4e;border-color:#eea236}.btn-warning .badge{color:#f0ad4e;background-color:#fff}.btn-danger{color:#fff;background-color:#d9534f;border-color:#d43f3a}.btn-danger.focus,.btn-danger:focus{color:#fff;background-color:#c9302c;border-color:#761c19}.btn-danger:hover{color:#fff;background-color:#c9302c;border-color:#ac2925}.btn-danger.active,.btn-danger:active,.open>.dropdown-toggle.btn-danger{color:#fff;background-color:#c9302c;border-color:#ac2925}.btn-danger.active.focus,.btn-danger.active:focus,.btn-danger.active:hover,.btn-danger:active.focus,.btn-danger:active:focus,.btn-danger:active:hover,.open>.dropdown-toggle.btn-danger.focus,.open>.dropdown-toggle.btn-danger:focus,.open>.dropdown-toggle.btn-danger:hover{color:#fff;background-color:#ac2925;border-color:#761c19}.btn-danger.active,.btn-danger:active,.open>.dropdown-toggle.btn-danger{background-image:none}.btn-danger.disabled.focus,.btn-danger.disabled:focus,.btn-danger.disabled:hover,.btn-danger[disabled].focus,.btn-danger[disabled]:focus,.btn-danger[disabled]:hover,fieldset[disabled] .btn-danger.focus,fieldset[disabled] .btn-danger:focus,fieldset[disabled] .btn-danger:hover{background-color:#d9534f;border-color:#d43f3a}.btn-danger .badge{color:#d9534f;background-color:#fff}.btn-link{font-weight:400;color:#337ab7;border-radius:0}.btn-link,.btn-link.active,.btn-link:active,.btn-link[disabled],fieldset[disabled] .btn-link{background-color:transparent;-webkit-box-shadow:none;box-shadow:none}.btn-link,.btn-link:active,.btn-link:focus,.btn-link:hover{border-color:transparent}.btn-link:focus,.btn-link:hover{color:#23527c;text-decoration:underline;background-color:transparent}.btn-link[disabled]:focus,.btn-link[disabled]:hover,fieldset[disabled] .btn-link:focus,fieldset[disabled] .btn-link:hover{color:#777;text-decoration:none}.btn-group-lg>.btn,.btn-lg{padding:10px 16px;font-size:18px;line-height:1.3333333;border-radius:6px}.btn-group-sm>.btn,.btn-sm{padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}.btn-group-xs>.btn,.btn-xs{padding:1px 5px;font-size:12px;line-height:1.5;border-radius:3px}.btn-block{display:block;width:100%}.btn-block+.btn-block{margin-top:5px}input[type=button].btn-block,input[type=reset].btn-block,input[type=submit].btn-block{width:100%}.fade{opacity:0;-webkit-transition:opacity .15s linear;-o-transition:opacity .15s linear;transition:opacity .15s linear}.fade.in{opacity:1}.collapse{display:none}.collapse.in{display:block}tr.collapse.in{display:table-row}tbody.collapse.in{display:table-row-group}.collapsing{position:relative;height:0;overflow:hidden;-webkit-transition-timing-function:ease;-o-transition-timing-function:ease;transition-timing-function:ease;-webkit-transition-duration:.35s;-o-transition-duration:.35s;transition-duration:.35s;-webkit-transition-property:height,visibility;-o-transition-property:height,visibility;transition-property:height,visibility}.caret{display:inline-block;width:0;height:0;margin-left:2px;vertical-align:middle;border-top:4px dashed;border-top:4px solid\9;border-right:4px solid transparent;border-left:4px solid transparent}.dropdown,.dropup{position:relative}.dropdown-toggle:focus{outline:0}.dropdown-menu{position:absolute;top:100%;left:0;z-index:1000;display:none;float:left;min-width:160px;padding:5px 0;margin:2px 0 0;font-size:14px;text-align:left;list-style:none;background-color:#fff;-webkit-background-clip:padding-box;background-clip:padding-box;border:1px solid #ccc;border:1px solid rgba(0,0,0,.15);border-radius:4px;-webkit-box-shadow:0 6px 12px rgba(0,0,0,.175);box-shadow:0 6px 12px rgba(0,0,0,.175)}.dropdown-menu.pull-right{right:0;left:auto}.dropdown-menu .divider{height:1px;margin:9px 0;overflow:hidden;background-color:#e5e5e5}.dropdown-menu>li>a{display:block;padding:3px 20px;clear:both;font-weight:400;line-height:1.42857143;color:#333;white-space:nowrap}.dropdown-menu>li>a:focus,.dropdown-menu>li>a:hover{color:#262626;text-decoration:none;background-color:#f5f5f5}.dropdown-menu>.active>a,.dropdown-menu>.active>a:focus,.dropdown-menu>.active>a:hover{color:#fff;text-decoration:none;background-color:#337ab7;outline:0}.dropdown-menu>.disabled>a,.dropdown-menu>.disabled>a:focus,.dropdown-menu>.disabled>a:hover{color:#777}.dropdown-menu>.disabled>a:focus,.dropdown-menu>.disabled>a:hover{text-decoration:none;cursor:not-allowed;background-color:transparent;background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled=false)}.open>.dropdown-menu{display:block}.open>a{outline:0}.dropdown-menu-right{right:0;left:auto}.dropdown-menu-left{right:auto;left:0}.dropdown-header{display:block;padding:3px 20px;font-size:12px;line-height:1.42857143;color:#777;white-space:nowrap}.dropdown-backdrop{position:fixed;top:0;right:0;bottom:0;left:0;z-index:990}.pull-right>.dropdown-menu{right:0;left:auto}.dropup .caret,.navbar-fixed-bottom .dropdown .caret{content:"";border-top:0;border-bottom:4px dashed;border-bottom:4px solid\9}.dropup .dropdown-menu,.navbar-fixed-bottom .dropdown .dropdown-menu{top:auto;bottom:100%;margin-bottom:2px}@media (min-width:768px){.navbar-right .dropdown-menu{right:0;left:auto}.navbar-right .dropdown-menu-left{right:auto;left:0}}.btn-group,.btn-group-vertical{position:relative;display:inline-block;vertical-align:middle}.btn-group-vertical>.btn,.btn-group>.btn{position:relative;float:left}.btn-group-vertical>.btn.active,.btn-group-vertical>.btn:active,.btn-group-vertical>.btn:focus,.btn-group-vertical>.btn:hover,.btn-group>.btn.active,.btn-group>.btn:active,.btn-group>.btn:focus,.btn-group>.btn:hover{z-index:2}.btn-group .btn+.btn,.btn-group .btn+.btn-group,.btn-group .btn-group+.btn,.btn-group .btn-group+.btn-group{margin-left:-1px}.btn-toolbar{margin-left:-5px}.btn-toolbar .btn,.btn-toolbar .btn-group,.btn-toolbar .input-group{float:left}.btn-toolbar>.btn,.btn-toolbar>.btn-group,.btn-toolbar>.input-group{margin-left:5px}.btn-group>.btn:not(:first-child):not(:last-child):not(.dropdown-toggle){border-radius:0}.btn-group>.btn:first-child{margin-left:0}.btn-group>.btn:first-child:not(:last-child):not(.dropdown-toggle){border-top-right-radius:0;border-bottom-right-radius:0}.btn-group>.btn:last-child:not(:first-child),.btn-group>.dropdown-toggle:not(:first-child){border-top-left-radius:0;border-bottom-left-radius:0}.btn-group>.btn-group{float:left}.btn-group>.btn-group:not(:first-child):not(:last-child)>.btn{border-radius:0}.btn-group>.btn-group:first-child:not(:last-child)>.btn:last-child,.btn-group>.btn-group:first-child:not(:last-child)>.dropdown-toggle{border-top-right-radius:0;border-bottom-right-radius:0}.btn-group>.btn-group:last-child:not(:first-child)>.btn:first-child{border-top-left-radius:0;border-bottom-left-radius:0}.btn-group .dropdown-toggle:active,.btn-group.open .dropdown-toggle{outline:0}.btn-group>.btn+.dropdown-toggle{padding-right:8px;padding-left:8px}.btn-group>.btn-lg+.dropdown-toggle{padding-right:12px;padding-left:12px}.btn-group.open .dropdown-toggle{-webkit-box-shadow:inset 0 3px 5px rgba(0,0,0,.125);box-shadow:inset 0 3px 5px rgba(0,0,0,.125)}.btn-group.open .dropdown-toggle.btn-link{-webkit-box-shadow:none;box-shadow:none}.btn .caret{margin-left:0}.btn-lg .caret{border-width:5px 5px 0;border-bottom-width:0}.dropup .btn-lg .caret{border-width:0 5px 5px}.btn-group-vertical>.btn,.btn-group-vertical>.btn-group,.btn-group-vertical>.btn-group>.btn{display:block;float:none;width:100%;max-width:100%}.btn-group-vertical>.btn-group>.btn{float:none}.btn-group-vertical>.btn+.btn,.btn-group-vertical>.btn+.btn-group,.btn-group-vertical>.btn-group+.btn,.btn-group-vertical>.btn-group+.btn-group{margin-top:-1px;margin-left:0}.btn-group-vertical>.btn:not(:first-child):not(:last-child){border-radius:0}.btn-group-vertical>.btn:first-child:not(:last-child){border-top-left-radius:4px;border-top-right-radius:4px;border-bottom-right-radius:0;border-bottom-left-radius:0}.btn-group-vertical>.btn:last-child:not(:first-child){border-top-left-radius:0;border-top-right-radius:0;border-bottom-right-radius:4px;border-bottom-left-radius:4px}.btn-group-vertical>.btn-group:not(:first-child):not(:last-child)>.btn{border-radius:0}.btn-group-vertical>.btn-group:first-child:not(:last-child)>.btn:last-child,.btn-group-vertical>.btn-group:first-child:not(:last-child)>.dropdown-toggle{border-bottom-right-radius:0;border-bottom-left-radius:0}.btn-group-vertical>.btn-group:last-child:not(:first-child)>.btn:first-child{border-top-left-radius:0;border-top-right-radius:0}.btn-group-justified{display:table;width:100%;table-layout:fixed;border-collapse:separate}.btn-group-justified>.btn,.btn-group-justified>.btn-group{display:table-cell;float:none;width:1%}.btn-group-justified>.btn-group .btn{width:100%}.btn-group-justified>.btn-group .dropdown-menu{left:auto}[data-toggle=buttons]>.btn input[type=checkbox],[data-toggle=buttons]>.btn input[type=radio],[data-toggle=buttons]>.btn-group>.btn input[type=checkbox],[data-toggle=buttons]>.btn-group>.btn input[type=radio]{position:absolute;clip:rect(0,0,0,0);pointer-events:none}.input-group{position:relative;display:table;border-collapse:separate}.input-group[class*=col-]{float:none;padding-right:0;padding-left:0}.input-group .form-control{position:relative;z-index:2;float:left;width:100%;margin-bottom:0}.input-group .form-control:focus{z-index:3}.input-group-lg>.form-control,.input-group-lg>.input-group-addon,.input-group-lg>.input-group-btn>.btn{height:46px;padding:10px 16px;font-size:18px;line-height:1.3333333;border-radius:6px}select.input-group-lg>.form-control,select.input-group-lg>.input-group-addon,select.input-group-lg>.input-group-btn>.btn{height:46px;line-height:46px}select[multiple].input-group-lg>.form-control,select[multiple].input-group-lg>.input-group-addon,select[multiple].input-group-lg>.input-group-btn>.btn,textarea.input-group-lg>.form-control,textarea.input-group-lg>.input-group-addon,textarea.input-group-lg>.input-group-btn>.btn{height:auto}.input-group-sm>.form-control,.input-group-sm>.input-group-addon,.input-group-sm>.input-group-btn>.btn{height:30px;padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}select.input-group-sm>.form-control,select.input-group-sm>.input-group-addon,select.input-group-sm>.input-group-btn>.btn{height:30px;line-height:30px}select[multiple].input-group-sm>.form-control,select[multiple].input-group-sm>.input-group-addon,select[multiple].input-group-sm>.input-group-btn>.btn,textarea.input-group-sm>.form-control,textarea.input-group-sm>.input-group-addon,textarea.input-group-sm>.input-group-btn>.btn{height:auto}.input-group .form-control,.input-group-addon,.input-group-btn{display:table-cell}.input-group .form-control:not(:first-child):not(:last-child),.input-group-addon:not(:first-child):not(:last-child),.input-group-btn:not(:first-child):not(:last-child){border-radius:0}.input-group-addon,.input-group-btn{width:1%;white-space:nowrap;vertical-align:middle}.input-group-addon{padding:6px 12px;font-size:14px;font-weight:400;line-height:1;color:#555;text-align:center;background-color:#eee;border:1px solid #ccc;border-radius:4px}.input-group-addon.input-sm{padding:5px 10px;font-size:12px;border-radius:3px}.input-group-addon.input-lg{padding:10px 16px;font-size:18px;border-radius:6px}.input-group-addon input[type=checkbox],.input-group-addon input[type=radio]{margin-top:0}.input-group .form-control:first-child,.input-group-addon:first-child,.input-group-btn:first-child>.btn,.input-group-btn:first-child>.btn-group>.btn,.input-group-btn:first-child>.dropdown-toggle,.input-group-btn:last-child>.btn-group:not(:last-child)>.btn,.input-group-btn:last-child>.btn:not(:last-child):not(.dropdown-toggle){border-top-right-radius:0;border-bottom-right-radius:0}.input-group-addon:first-child{border-right:0}.input-group .form-control:last-child,.input-group-addon:last-child,.input-group-btn:first-child>.btn-group:not(:first-child)>.btn,.input-group-btn:first-child>.btn:not(:first-child),.input-group-btn:last-child>.btn,.input-group-btn:last-child>.btn-group>.btn,.input-group-btn:last-child>.dropdown-toggle{border-top-left-radius:0;border-bottom-left-radius:0}.input-group-addon:last-child{border-left:0}.input-group-btn{position:relative;font-size:0;white-space:nowrap}.input-group-btn>.btn{position:relative}.input-group-btn>.btn+.btn{margin-left:-1px}.input-group-btn>.btn:active,.input-group-btn>.btn:focus,.input-group-btn>.btn:hover{z-index:2}.input-group-btn:first-child>.btn,.input-group-btn:first-child>.btn-group{margin-right:-1px}.input-group-btn:last-child>.btn,.input-group-btn:last-child>.btn-group{z-index:2;margin-left:-1px}.nav{padding-left:0;margin-bottom:0;list-style:none}.nav>li{position:relative;display:block}.nav>li>a{position:relative;display:block;padding:10px 15px}.nav>li>a:focus,.nav>li>a:hover{text-decoration:none;background-color:#eee}.nav>li.disabled>a{color:#777}.nav>li.disabled>a:focus,.nav>li.disabled>a:hover{color:#777;text-decoration:none;cursor:not-allowed;background-color:transparent}.nav .open>a,.nav .open>a:focus,.nav .open>a:hover{background-color:#eee;border-color:#337ab7}.nav .nav-divider{height:1px;margin:9px 0;overflow:hidden;background-color:#e5e5e5}.nav>li>a>img{max-width:none}.nav-tabs{border-bottom:1px solid #ddd}.nav-tabs>li{float:left;margin-bottom:-1px}.nav-tabs>li>a{margin-right:2px;line-height:1.42857143;border:1px solid transparent;border-radius:4px 4px 0 0}.nav-tabs>li>a:hover{border-color:#eee #eee #ddd}.nav-tabs>li.active>a,.nav-tabs>li.active>a:focus,.nav-tabs>li.active>a:hover{color:#555;cursor:default;background-color:#fff;border:1px solid #ddd;border-bottom-color:transparent}.nav-tabs.nav-justified{width:100%;border-bottom:0}.nav-tabs.nav-justified>li{float:none}.nav-tabs.nav-justified>li>a{margin-bottom:5px;text-align:center}.nav-tabs.nav-justified>.dropdown .dropdown-menu{top:auto;left:auto}@media (min-width:768px){.nav-tabs.nav-justified>li{display:table-cell;width:1%}.nav-tabs.nav-justified>li>a{margin-bottom:0}}.nav-tabs.nav-justified>li>a{margin-right:0;border-radius:4px}.nav-tabs.nav-justified>.active>a,.nav-tabs.nav-justified>.active>a:focus,.nav-tabs.nav-justified>.active>a:hover{border:1px solid #ddd}@media (min-width:768px){.nav-tabs.nav-justified>li>a{border-bottom:1px solid #ddd;border-radius:4px 4px 0 0}.nav-tabs.nav-justified>.active>a,.nav-tabs.nav-justified>.active>a:focus,.nav-tabs.nav-justified>.active>a:hover{border-bottom-color:#fff}}.nav-pills>li{float:left}.nav-pills>li>a{border-radius:4px}.nav-pills>li+li{margin-left:2px}.nav-pills>li.active>a,.nav-pills>li.active>a:focus,.nav-pills>li.active>a:hover{color:#fff;background-color:#337ab7}.nav-stacked>li{float:none}.nav-stacked>li+li{margin-top:2px;margin-left:0}.nav-justified{width:100%}.nav-justified>li{float:none}.nav-justified>li>a{margin-bottom:5px;text-align:center}.nav-justified>.dropdown .dropdown-menu{top:auto;left:auto}@media (min-width:768px){.nav-justified>li{display:table-cell;width:1%}.nav-justified>li>a{margin-bottom:0}}.nav-tabs-justified{border-bottom:0}.nav-tabs-justified>li>a{margin-right:0;border-radius:4px}.nav-tabs-justified>.active>a,.nav-tabs-justified>.active>a:focus,.nav-tabs-justified>.active>a:hover{border:1px solid #ddd}@media (min-width:768px){.nav-tabs-justified>li>a{border-bottom:1px solid #ddd;border-radius:4px 4px 0 0}.nav-tabs-justified>.active>a,.nav-tabs-justified>.active>a:focus,.nav-tabs-justified>.active>a:hover{border-bottom-color:#fff}}.tab-content>.tab-pane{display:none}.tab-content>.active{display:block}.nav-tabs .dropdown-menu{margin-top:-1px;border-top-left-radius:0;border-top-right-radius:0}.navbar{position:relative;min-height:50px;margin-bottom:20px;border:1px solid transparent}@media (min-width:768px){.navbar{border-radius:4px}}@media (min-width:768px){.navbar-header{float:left}}.navbar-collapse{padding-right:15px;padding-left:15px;overflow-x:visible;-webkit-overflow-scrolling:touch;border-top:1px solid transparent;-webkit-box-shadow:inset 0 1px 0 rgba(255,255,255,.1);box-shadow:inset 0 1px 0 rgba(255,255,255,.1)}.navbar-collapse.in{overflow-y:auto}@media (min-width:768px){.navbar-collapse{width:auto;border-top:0;-webkit-box-shadow:none;box-shadow:none}.navbar-collapse.collapse{display:block!important;height:auto!important;padding-bottom:0;overflow:visible!important}.navbar-collapse.in{overflow-y:visible}.navbar-fixed-bottom .navbar-collapse,.navbar-fixed-top .navbar-collapse,.navbar-static-top .navbar-collapse{padding-right:0;padding-left:0}}.navbar-fixed-bottom .navbar-collapse,.navbar-fixed-top .navbar-collapse{max-height:340px}@media (max-device-width:480px) and (orientation:landscape){.navbar-fixed-bottom .navbar-collapse,.navbar-fixed-top .navbar-collapse{max-height:200px}}.container-fluid>.navbar-collapse,.container-fluid>.navbar-header,.container>.navbar-collapse,.container>.navbar-header{margin-right:-15px;margin-left:-15px}@media (min-width:768px){.container-fluid>.navbar-collapse,.container-fluid>.navbar-header,.container>.navbar-collapse,.container>.navbar-header{margin-right:0;margin-left:0}}.navbar-static-top{z-index:1000;border-width:0 0 1px}@media (min-width:768px){.navbar-static-top{border-radius:0}}.navbar-fixed-bottom,.navbar-fixed-top{position:fixed;right:0;left:0;z-index:1030}@media (min-width:768px){.navbar-fixed-bottom,.navbar-fixed-top{border-radius:0}}.navbar-fixed-top{top:0;border-width:0 0 1px}.navbar-fixed-bottom{bottom:0;margin-bottom:0;border-width:1px 0 0}.navbar-brand{float:left;height:50px;padding:15px 15px;font-size:18px;line-height:20px}.navbar-brand:focus,.navbar-brand:hover{text-decoration:none}.navbar-brand>img{display:block}@media (min-width:768px){.navbar>.container .navbar-brand,.navbar>.container-fluid .navbar-brand{margin-left:-15px}}.navbar-toggle{position:relative;float:right;padding:9px 10px;margin-top:8px;margin-right:15px;margin-bottom:8px;background-color:transparent;background-image:none;border:1px solid transparent;border-radius:4px}.navbar-toggle:focus{outline:0}.navbar-toggle .icon-bar{display:block;width:22px;height:2px;border-radius:1px}.navbar-toggle .icon-bar+.icon-bar{margin-top:4px}@media (min-width:768px){.navbar-toggle{display:none}}.navbar-nav{margin:7.5px -15px}.navbar-nav>li>a{padding-top:10px;padding-bottom:10px;line-height:20px}@media (max-width:767px){.navbar-nav .open .dropdown-menu{position:static;float:none;width:auto;margin-top:0;background-color:transparent;border:0;-webkit-box-shadow:none;box-shadow:none}.navbar-nav .open .dropdown-menu .dropdown-header,.navbar-nav .open .dropdown-menu>li>a{padding:5px 15px 5px 25px}.navbar-nav .open .dropdown-menu>li>a{line-height:20px}.navbar-nav .open .dropdown-menu>li>a:focus,.navbar-nav .open .dropdown-menu>li>a:hover{background-image:none}}@media (min-width:768px){.navbar-nav{float:left;margin:0}.navbar-nav>li{float:left}.navbar-nav>li>a{padding-top:15px;padding-bottom:15px}}.navbar-form{padding:10px 15px;margin-top:8px;margin-right:-15px;margin-bottom:8px;margin-left:-15px;border-top:1px solid transparent;border-bottom:1px solid transparent;-webkit-box-shadow:inset 0 1px 0 rgba(255,255,255,.1),0 1px 0 rgba(255,255,255,.1);box-shadow:inset 0 1px 0 rgba(255,255,255,.1),0 1px 0 rgba(255,255,255,.1)}@media (min-width:768px){.navbar-form .form-group{display:inline-block;margin-bottom:0;vertical-align:middle}.navbar-form .form-control{display:inline-block;width:auto;vertical-align:middle}.navbar-form .form-control-static{display:inline-block}.navbar-form .input-group{display:inline-table;vertical-align:middle}.navbar-form .input-group .form-control,.navbar-form .input-group .input-group-addon,.navbar-form .input-group .input-group-btn{width:auto}.navbar-form .input-group>.form-control{width:100%}.navbar-form .control-label{margin-bottom:0;vertical-align:middle}.navbar-form .checkbox,.navbar-form .radio{display:inline-block;margin-top:0;margin-bottom:0;vertical-align:middle}.navbar-form .checkbox label,.navbar-form .radio label{padding-left:0}.navbar-form .checkbox input[type=checkbox],.navbar-form .radio input[type=radio]{position:relative;margin-left:0}.navbar-form .has-feedback .form-control-feedback{top:0}}@media (max-width:767px){.navbar-form .form-group{margin-bottom:5px}.navbar-form .form-group:last-child{margin-bottom:0}}@media (min-width:768px){.navbar-form{width:auto;padding-top:0;padding-bottom:0;margin-right:0;margin-left:0;border:0;-webkit-box-shadow:none;box-shadow:none}}.navbar-nav>li>.dropdown-menu{margin-top:0;border-top-left-radius:0;border-top-right-radius:0}.navbar-fixed-bottom .navbar-nav>li>.dropdown-menu{margin-bottom:0;border-top-left-radius:4px;border-top-right-radius:4px;border-bottom-right-radius:0;border-bottom-left-radius:0}.navbar-btn{margin-top:8px;margin-bottom:8px}.navbar-btn.btn-sm{margin-top:10px;margin-bottom:10px}.navbar-btn.btn-xs{margin-top:14px;margin-bottom:14px}.navbar-text{margin-top:15px;margin-bottom:15px}@media (min-width:768px){.navbar-text{float:left;margin-right:15px;margin-left:15px}}@media (min-width:768px){.navbar-left{float:left!important}.navbar-right{float:right!important;margin-right:-15px}.navbar-right~.navbar-right{margin-right:0}}.navbar-default{background-color:#f8f8f8;border-color:#e7e7e7}.navbar-default .navbar-brand{color:#777}.navbar-default .navbar-brand:focus,.navbar-default .navbar-brand:hover{color:#5e5e5e;background-color:transparent}.navbar-default .navbar-text{color:#777}.navbar-default .navbar-nav>li>a{color:#777}.navbar-default .navbar-nav>li>a:focus,.navbar-default .navbar-nav>li>a:hover{color:#333;background-color:transparent}.navbar-default .navbar-nav>.active>a,.navbar-default .navbar-nav>.active>a:focus,.navbar-default .navbar-nav>.active>a:hover{color:#555;background-color:#e7e7e7}.navbar-default .navbar-nav>.disabled>a,.navbar-default .navbar-nav>.disabled>a:focus,.navbar-default .navbar-nav>.disabled>a:hover{color:#ccc;background-color:transparent}.navbar-default .navbar-toggle{border-color:#ddd}.navbar-default .navbar-toggle:focus,.navbar-default .navbar-toggle:hover{background-color:#ddd}.navbar-default .navbar-toggle .icon-bar{background-color:#888}.navbar-default .navbar-collapse,.navbar-default .navbar-form{border-color:#e7e7e7}.navbar-default .navbar-nav>.open>a,.navbar-default .navbar-nav>.open>a:focus,.navbar-default .navbar-nav>.open>a:hover{color:#555;background-color:#e7e7e7}@media (max-width:767px){.navbar-default .navbar-nav .open .dropdown-menu>li>a{color:#777}.navbar-default .navbar-nav .open .dropdown-menu>li>a:focus,.navbar-default .navbar-nav .open .dropdown-menu>li>a:hover{color:#333;background-color:transparent}.navbar-default .navbar-nav .open .dropdown-menu>.active>a,.navbar-default .navbar-nav .open .dropdown-menu>.active>a:focus,.navbar-default .navbar-nav .open .dropdown-menu>.active>a:hover{color:#555;background-color:#e7e7e7}.navbar-default .navbar-nav .open .dropdown-menu>.disabled>a,.navbar-default .navbar-nav .open .dropdown-menu>.disabled>a:focus,.navbar-default .navbar-nav .open .dropdown-menu>.disabled>a:hover{color:#ccc;background-color:transparent}}.navbar-default .navbar-link{color:#777}.navbar-default .navbar-link:hover{color:#333}.navbar-default .btn-link{color:#777}.navbar-default .btn-link:focus,.navbar-default .btn-link:hover{color:#333}.navbar-default .btn-link[disabled]:focus,.navbar-default .btn-link[disabled]:hover,fieldset[disabled] .navbar-default .btn-link:focus,fieldset[disabled] .navbar-default .btn-link:hover{color:#ccc}.navbar-inverse{background-color:#222;border-color:#080808}.navbar-inverse .navbar-brand{color:#9d9d9d}.navbar-inverse .navbar-brand:focus,.navbar-inverse .navbar-brand:hover{color:#fff;background-color:transparent}.navbar-inverse .navbar-text{color:#9d9d9d}.navbar-inverse .navbar-nav>li>a{color:#9d9d9d}.navbar-inverse .navbar-nav>li>a:focus,.navbar-inverse .navbar-nav>li>a:hover{color:#fff;background-color:transparent}.navbar-inverse .navbar-nav>.active>a,.navbar-inverse .navbar-nav>.active>a:focus,.navbar-inverse .navbar-nav>.active>a:hover{color:#fff;background-color:#080808}.navbar-inverse .navbar-nav>.disabled>a,.navbar-inverse .navbar-nav>.disabled>a:focus,.navbar-inverse .navbar-nav>.disabled>a:hover{color:#444;background-color:transparent}.navbar-inverse .navbar-toggle{border-color:#333}.navbar-inverse .navbar-toggle:focus,.navbar-inverse .navbar-toggle:hover{background-color:#333}.navbar-inverse .navbar-toggle .icon-bar{background-color:#fff}.navbar-inverse .navbar-collapse,.navbar-inverse .navbar-form{border-color:#101010}.navbar-inverse .navbar-nav>.open>a,.navbar-inverse .navbar-nav>.open>a:focus,.navbar-inverse .navbar-nav>.open>a:hover{color:#fff;background-color:#080808}@media (max-width:767px){.navbar-inverse .navbar-nav .open .dropdown-menu>.dropdown-header{border-color:#080808}.navbar-inverse .navbar-nav .open .dropdown-menu .divider{background-color:#080808}.navbar-inverse .navbar-nav .open .dropdown-menu>li>a{color:#9d9d9d}.navbar-inverse .navbar-nav .open .dropdown-menu>li>a:focus,.navbar-inverse .navbar-nav .open .dropdown-menu>li>a:hover{color:#fff;background-color:transparent}.navbar-inverse .navbar-nav .open .dropdown-menu>.active>a,.navbar-inverse .navbar-nav .open .dropdown-menu>.active>a:focus,.navbar-inverse .navbar-nav .open .dropdown-menu>.active>a:hover{color:#fff;background-color:#080808}.navbar-inverse .navbar-nav .open .dropdown-menu>.disabled>a,.navbar-inverse .navbar-nav .open .dropdown-menu>.disabled>a:focus,.navbar-inverse .navbar-nav .open .dropdown-menu>.disabled>a:hover{color:#444;background-color:transparent}}.navbar-inverse .navbar-link{color:#9d9d9d}.navbar-inverse .navbar-link:hover{color:#fff}.navbar-inverse .btn-link{color:#9d9d9d}.navbar-inverse .btn-link:focus,.navbar-inverse .btn-link:hover{color:#fff}.navbar-inverse .btn-link[disabled]:focus,.navbar-inverse .btn-link[disabled]:hover,fieldset[disabled] .navbar-inverse .btn-link:focus,fieldset[disabled] .navbar-inverse .btn-link:hover{color:#444}.breadcrumb{padding:8px 15px;margin-bottom:20px;list-style:none;background-color:#f5f5f5;border-radius:4px}.breadcrumb>li{display:inline-block}.breadcrumb>li+li:before{padding:0 5px;color:#ccc;content:"/\00a0"}.breadcrumb>.active{color:#777}.pagination{display:inline-block;padding-left:0;margin:20px 0;border-radius:4px}.pagination>li{display:inline}.pagination>li>a,.pagination>li>span{position:relative;float:left;padding:6px 12px;margin-left:-1px;line-height:1.42857143;color:#337ab7;text-decoration:none;background-color:#fff;border:1px solid #ddd}.pagination>li:first-child>a,.pagination>li:first-child>span{margin-left:0;border-top-left-radius:4px;border-bottom-left-radius:4px}.pagination>li:last-child>a,.pagination>li:last-child>span{border-top-right-radius:4px;border-bottom-right-radius:4px}.pagination>li>a:focus,.pagination>li>a:hover,.pagination>li>span:focus,.pagination>li>span:hover{z-index:2;color:#23527c;background-color:#eee;border-color:#ddd}.pagination>.active>a,.pagination>.active>a:focus,.pagination>.active>a:hover,.pagination>.active>span,.pagination>.active>span:focus,.pagination>.active>span:hover{z-index:3;color:#fff;cursor:default;background-color:#337ab7;border-color:#337ab7}.pagination>.disabled>a,.pagination>.disabled>a:focus,.pagination>.disabled>a:hover,.pagination>.disabled>span,.pagination>.disabled>span:focus,.pagination>.disabled>span:hover{color:#777;cursor:not-allowed;background-color:#fff;border-color:#ddd}.pagination-lg>li>a,.pagination-lg>li>span{padding:10px 16px;font-size:18px;line-height:1.3333333}.pagination-lg>li:first-child>a,.pagination-lg>li:first-child>span{border-top-left-radius:6px;border-bottom-left-radius:6px}.pagination-lg>li:last-child>a,.pagination-lg>li:last-child>span{border-top-right-radius:6px;border-bottom-right-radius:6px}.pagination-sm>li>a,.pagination-sm>li>span{padding:5px 10px;font-size:12px;line-height:1.5}.pagination-sm>li:first-child>a,.pagination-sm>li:first-child>span{border-top-left-radius:3px;border-bottom-left-radius:3px}.pagination-sm>li:last-child>a,.pagination-sm>li:last-child>span{border-top-right-radius:3px;border-bottom-right-radius:3px}.pager{padding-left:0;margin:20px 0;text-align:center;list-style:none}.pager li{display:inline}.pager li>a,.pager li>span{display:inline-block;padding:5px 14px;background-color:#fff;border:1px solid #ddd;border-radius:15px}.pager li>a:focus,.pager li>a:hover{text-decoration:none;background-color:#eee}.pager .next>a,.pager .next>span{float:right}.pager .previous>a,.pager .previous>span{float:left}.pager .disabled>a,.pager .disabled>a:focus,.pager .disabled>a:hover,.pager .disabled>span{color:#777;cursor:not-allowed;background-color:#fff}.label{display:inline;padding:.2em .6em .3em;font-size:75%;font-weight:700;line-height:1;color:#fff;text-align:center;white-space:nowrap;vertical-align:baseline;border-radius:.25em}a.label:focus,a.label:hover{color:#fff;text-decoration:none;cursor:pointer}.label:empty{display:none}.btn .label{position:relative;top:-1px}.label-default{background-color:#777}.label-default[href]:focus,.label-default[href]:hover{background-color:#5e5e5e}.label-primary{background-color:#337ab7}.label-primary[href]:focus,.label-primary[href]:hover{background-color:#286090}.label-success{background-color:#5cb85c}.label-success[href]:focus,.label-success[href]:hover{background-color:#449d44}.label-info{background-color:#5bc0de}.label-info[href]:focus,.label-info[href]:hover{background-color:#31b0d5}.label-warning{background-color:#f0ad4e}.label-warning[href]:focus,.label-warning[href]:hover{background-color:#ec971f}.label-danger{background-color:#d9534f}.label-danger[href]:focus,.label-danger[href]:hover{background-color:#c9302c}.badge{display:inline-block;min-width:10px;padding:3px 7px;font-size:12px;font-weight:700;line-height:1;color:#fff;text-align:center;white-space:nowrap;vertical-align:middle;background-color:#777;border-radius:10px}.badge:empty{display:none}.btn .badge{position:relative;top:-1px}.btn-group-xs>.btn .badge,.btn-xs .badge{top:0;padding:1px 5px}a.badge:focus,a.badge:hover{color:#fff;text-decoration:none;cursor:pointer}.list-group-item.active>.badge,.nav-pills>.active>a>.badge{color:#337ab7;background-color:#fff}.list-group-item>.badge{float:right}.list-group-item>.badge+.badge{margin-right:5px}.nav-pills>li>a>.badge{margin-left:3px}.jumbotron{padding-top:30px;padding-bottom:30px;margin-bottom:30px;color:inherit;background-color:#eee}.jumbotron .h1,.jumbotron h1{color:inherit}.jumbotron p{margin-bottom:15px;font-size:21px;font-weight:200}.jumbotron>hr{border-top-color:#d5d5d5}.container .jumbotron,.container-fluid .jumbotron{padding-right:15px;padding-left:15px;border-radius:6px}.jumbotron .container{max-width:100%}@media screen and (min-width:768px){.jumbotron{padding-top:48px;padding-bottom:48px}.container .jumbotron,.container-fluid .jumbotron{padding-right:60px;padding-left:60px}.jumbotron .h1,.jumbotron h1{font-size:63px}}.thumbnail{display:block;padding:4px;margin-bottom:20px;line-height:1.42857143;background-color:#fff;border:1px solid #ddd;border-radius:4px;-webkit-transition:border .2s ease-in-out;-o-transition:border .2s ease-in-out;transition:border .2s ease-in-out}.thumbnail a>img,.thumbnail>img{margin-right:auto;margin-left:auto}a.thumbnail.active,a.thumbnail:focus,a.thumbnail:hover{border-color:#337ab7}.thumbnail .caption{padding:9px;color:#333}.alert{padding:15px;margin-bottom:20px;border:1px solid transparent;border-radius:4px}.alert h4{margin-top:0;color:inherit}.alert .alert-link{font-weight:700}.alert>p,.alert>ul{margin-bottom:0}.alert>p+p{margin-top:5px}.alert-dismissable,.alert-dismissible{padding-right:35px}.alert-dismissable .close,.alert-dismissible .close{position:relative;top:-2px;right:-21px;color:inherit}.alert-success{color:#3c763d;background-color:#dff0d8;border-color:#d6e9c6}.alert-success hr{border-top-color:#c9e2b3}.alert-success .alert-link{color:#2b542c}.alert-info{color:#31708f;background-color:#d9edf7;border-color:#bce8f1}.alert-info hr{border-top-color:#a6e1ec}.alert-info .alert-link{color:#245269}.alert-warning{color:#8a6d3b;background-color:#fcf8e3;border-color:#faebcc}.alert-warning hr{border-top-color:#f7e1b5}.alert-warning .alert-link{color:#66512c}.alert-danger{color:#a94442;background-color:#f2dede;border-color:#ebccd1}.alert-danger hr{border-top-color:#e4b9c0}.alert-danger .alert-link{color:#843534}@-webkit-keyframes progress-bar-stripes{from{background-position:40px 0}to{background-position:0 0}}@-o-keyframes progress-bar-stripes{from{background-position:40px 0}to{background-position:0 0}}@keyframes progress-bar-stripes{from{background-position:40px 0}to{background-position:0 0}}.progress{height:20px;margin-bottom:20px;overflow:hidden;background-color:#f5f5f5;border-radius:4px;-webkit-box-shadow:inset 0 1px 2px rgba(0,0,0,.1);box-shadow:inset 0 1px 2px rgba(0,0,0,.1)}.progress-bar{float:left;width:0;height:100%;font-size:12px;line-height:20px;color:#fff;text-align:center;background-color:#337ab7;-webkit-box-shadow:inset 0 -1px 0 rgba(0,0,0,.15);box-shadow:inset 0 -1px 0 rgba(0,0,0,.15);-webkit-transition:width .6s ease;-o-transition:width .6s ease;transition:width .6s ease}.progress-bar-striped,.progress-striped .progress-bar{background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);-webkit-background-size:40px 40px;background-size:40px 40px}.progress-bar.active,.progress.active .progress-bar{-webkit-animation:progress-bar-stripes 2s linear infinite;-o-animation:progress-bar-stripes 2s linear infinite;animation:progress-bar-stripes 2s linear infinite}.progress-bar-success{background-color:#5cb85c}.progress-striped .progress-bar-success{background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent)}.progress-bar-info{background-color:#5bc0de}.progress-striped .progress-bar-info{background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent)}.progress-bar-warning{background-color:#f0ad4e}.progress-striped .progress-bar-warning{background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent)}.progress-bar-danger{background-color:#d9534f}.progress-striped .progress-bar-danger{background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent)}.media{margin-top:15px}.media:first-child{margin-top:0}.media,.media-body{overflow:hidden;zoom:1}.media-body{width:10000px}.media-object{display:block}.media-object.img-thumbnail{max-width:none}.media-right,.media>.pull-right{padding-left:10px}.media-left,.media>.pull-left{padding-right:10px}.media-body,.media-left,.media-right{display:table-cell;vertical-align:top}.media-middle{vertical-align:middle}.media-bottom{vertical-align:bottom}.media-heading{margin-top:0;margin-bottom:5px}.media-list{padding-left:0;list-style:none}.list-group{padding-left:0;margin-bottom:20px}.list-group-item{position:relative;display:block;padding:10px 15px;margin-bottom:-1px;background-color:#fff;border:1px solid #ddd}.list-group-item:first-child{border-top-left-radius:4px;border-top-right-radius:4px}.list-group-item:last-child{margin-bottom:0;border-bottom-right-radius:4px;border-bottom-left-radius:4px}a.list-group-item,button.list-group-item{color:#555}a.list-group-item .list-group-item-heading,button.list-group-item .list-group-item-heading{color:#333}a.list-group-item:focus,a.list-group-item:hover,button.list-group-item:focus,button.list-group-item:hover{color:#555;text-decoration:none;background-color:#f5f5f5}button.list-group-item{width:100%;text-align:left}.list-group-item.disabled,.list-group-item.disabled:focus,.list-group-item.disabled:hover{color:#777;cursor:not-allowed;background-color:#eee}.list-group-item.disabled .list-group-item-heading,.list-group-item.disabled:focus .list-group-item-heading,.list-group-item.disabled:hover .list-group-item-heading{color:inherit}.list-group-item.disabled .list-group-item-text,.list-group-item.disabled:focus .list-group-item-text,.list-group-item.disabled:hover .list-group-item-text{color:#777}.list-group-item.active,.list-group-item.active:focus,.list-group-item.active:hover{z-index:2;color:#fff;background-color:#337ab7;border-color:#337ab7}.list-group-item.active .list-group-item-heading,.list-group-item.active .list-group-item-heading>.small,.list-group-item.active .list-group-item-heading>small,.list-group-item.active:focus .list-group-item-heading,.list-group-item.active:focus .list-group-item-heading>.small,.list-group-item.active:focus .list-group-item-heading>small,.list-group-item.active:hover .list-group-item-heading,.list-group-item.active:hover .list-group-item-heading>.small,.list-group-item.active:hover .list-group-item-heading>small{color:inherit}.list-group-item.active .list-group-item-text,.list-group-item.active:focus .list-group-item-text,.list-group-item.active:hover .list-group-item-text{color:#c7ddef}.list-group-item-success{color:#3c763d;background-color:#dff0d8}a.list-group-item-success,button.list-group-item-success{color:#3c763d}a.list-group-item-success .list-group-item-heading,button.list-group-item-success .list-group-item-heading{color:inherit}a.list-group-item-success:focus,a.list-group-item-success:hover,button.list-group-item-success:focus,button.list-group-item-success:hover{color:#3c763d;background-color:#d0e9c6}a.list-group-item-success.active,a.list-group-item-success.active:focus,a.list-group-item-success.active:hover,button.list-group-item-success.active,button.list-group-item-success.active:focus,button.list-group-item-success.active:hover{color:#fff;background-color:#3c763d;border-color:#3c763d}.list-group-item-info{color:#31708f;background-color:#d9edf7}a.list-group-item-info,button.list-group-item-info{color:#31708f}a.list-group-item-info .list-group-item-heading,button.list-group-item-info .list-group-item-heading{color:inherit}a.list-group-item-info:focus,a.list-group-item-info:hover,button.list-group-item-info:focus,button.list-group-item-info:hover{color:#31708f;background-color:#c4e3f3}a.list-group-item-info.active,a.list-group-item-info.active:focus,a.list-group-item-info.active:hover,button.list-group-item-info.active,button.list-group-item-info.active:focus,button.list-group-item-info.active:hover{color:#fff;background-color:#31708f;border-color:#31708f}.list-group-item-warning{color:#8a6d3b;background-color:#fcf8e3}a.list-group-item-warning,button.list-group-item-warning{color:#8a6d3b}a.list-group-item-warning .list-group-item-heading,button.list-group-item-warning .list-group-item-heading{color:inherit}a.list-group-item-warning:focus,a.list-group-item-warning:hover,button.list-group-item-warning:focus,button.list-group-item-warning:hover{color:#8a6d3b;background-color:#faf2cc}a.list-group-item-warning.active,a.list-group-item-warning.active:focus,a.list-group-item-warning.active:hover,button.list-group-item-warning.active,button.list-group-item-warning.active:focus,button.list-group-item-warning.active:hover{color:#fff;background-color:#8a6d3b;border-color:#8a6d3b}.list-group-item-danger{color:#a94442;background-color:#f2dede}a.list-group-item-danger,button.list-group-item-danger{color:#a94442}a.list-group-item-danger .list-group-item-heading,button.list-group-item-danger .list-group-item-heading{color:inherit}a.list-group-item-danger:focus,a.list-group-item-danger:hover,button.list-group-item-danger:focus,button.list-group-item-danger:hover{color:#a94442;background-color:#ebcccc}a.list-group-item-danger.active,a.list-group-item-danger.active:focus,a.list-group-item-danger.active:hover,button.list-group-item-danger.active,button.list-group-item-danger.active:focus,button.list-group-item-danger.active:hover{color:#fff;background-color:#a94442;border-color:#a94442}.list-group-item-heading{margin-top:0;margin-bottom:5px}.list-group-item-text{margin-bottom:0;line-height:1.3}.panel{margin-bottom:20px;background-color:#fff;border:1px solid transparent;border-radius:4px;-webkit-box-shadow:0 1px 1px rgba(0,0,0,.05);box-shadow:0 1px 1px rgba(0,0,0,.05)}.panel-body{padding:15px}.panel-heading{padding:10px 15px;border-bottom:1px solid transparent;border-top-left-radius:3px;border-top-right-radius:3px}.panel-heading>.dropdown .dropdown-toggle{color:inherit}.panel-title{margin-top:0;margin-bottom:0;font-size:16px;color:inherit}.panel-title>.small,.panel-title>.small>a,.panel-title>a,.panel-title>small,.panel-title>small>a{color:inherit}.panel-footer{padding:10px 15px;background-color:#f5f5f5;border-top:1px solid #ddd;border-bottom-right-radius:3px;border-bottom-left-radius:3px}.panel>.list-group,.panel>.panel-collapse>.list-group{margin-bottom:0}.panel>.list-group .list-group-item,.panel>.panel-collapse>.list-group .list-group-item{border-width:1px 0;border-radius:0}.panel>.list-group:first-child .list-group-item:first-child,.panel>.panel-collapse>.list-group:first-child .list-group-item:first-child{border-top:0;border-top-left-radius:3px;border-top-right-radius:3px}.panel>.list-group:last-child .list-group-item:last-child,.panel>.panel-collapse>.list-group:last-child .list-group-item:last-child{border-bottom:0;border-bottom-right-radius:3px;border-bottom-left-radius:3px}.panel>.panel-heading+.panel-collapse>.list-group .list-group-item:first-child{border-top-left-radius:0;border-top-right-radius:0}.panel-heading+.list-group .list-group-item:first-child{border-top-width:0}.list-group+.panel-footer{border-top-width:0}.panel>.panel-collapse>.table,.panel>.table,.panel>.table-responsive>.table{margin-bottom:0}.panel>.panel-collapse>.table caption,.panel>.table caption,.panel>.table-responsive>.table caption{padding-right:15px;padding-left:15px}.panel>.table-responsive:first-child>.table:first-child,.panel>.table:first-child{border-top-left-radius:3px;border-top-right-radius:3px}.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child,.panel>.table:first-child>tbody:first-child>tr:first-child,.panel>.table:first-child>thead:first-child>tr:first-child{border-top-left-radius:3px;border-top-right-radius:3px}.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child td:first-child,.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child th:first-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child td:first-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child th:first-child,.panel>.table:first-child>tbody:first-child>tr:first-child td:first-child,.panel>.table:first-child>tbody:first-child>tr:first-child th:first-child,.panel>.table:first-child>thead:first-child>tr:first-child td:first-child,.panel>.table:first-child>thead:first-child>tr:first-child th:first-child{border-top-left-radius:3px}.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child td:last-child,.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child th:last-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child td:last-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child th:last-child,.panel>.table:first-child>tbody:first-child>tr:first-child td:last-child,.panel>.table:first-child>tbody:first-child>tr:first-child th:last-child,.panel>.table:first-child>thead:first-child>tr:first-child td:last-child,.panel>.table:first-child>thead:first-child>tr:first-child th:last-child{border-top-right-radius:3px}.panel>.table-responsive:last-child>.table:last-child,.panel>.table:last-child{border-bottom-right-radius:3px;border-bottom-left-radius:3px}.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child,.panel>.table:last-child>tbody:last-child>tr:last-child,.panel>.table:last-child>tfoot:last-child>tr:last-child{border-bottom-right-radius:3px;border-bottom-left-radius:3px}.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child td:first-child,.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child th:first-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child td:first-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child th:first-child,.panel>.table:last-child>tbody:last-child>tr:last-child td:first-child,.panel>.table:last-child>tbody:last-child>tr:last-child th:first-child,.panel>.table:last-child>tfoot:last-child>tr:last-child td:first-child,.panel>.table:last-child>tfoot:last-child>tr:last-child th:first-child{border-bottom-left-radius:3px}.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child td:last-child,.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child th:last-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child td:last-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child th:last-child,.panel>.table:last-child>tbody:last-child>tr:last-child td:last-child,.panel>.table:last-child>tbody:last-child>tr:last-child th:last-child,.panel>.table:last-child>tfoot:last-child>tr:last-child td:last-child,.panel>.table:last-child>tfoot:last-child>tr:last-child th:last-child{border-bottom-right-radius:3px}.panel>.panel-body+.table,.panel>.panel-body+.table-responsive,.panel>.table+.panel-body,.panel>.table-responsive+.panel-body{border-top:1px solid #ddd}.panel>.table>tbody:first-child>tr:first-child td,.panel>.table>tbody:first-child>tr:first-child th{border-top:0}.panel>.table-bordered,.panel>.table-responsive>.table-bordered{border:0}.panel>.table-bordered>tbody>tr>td:first-child,.panel>.table-bordered>tbody>tr>th:first-child,.panel>.table-bordered>tfoot>tr>td:first-child,.panel>.table-bordered>tfoot>tr>th:first-child,.panel>.table-bordered>thead>tr>td:first-child,.panel>.table-bordered>thead>tr>th:first-child,.panel>.table-responsive>.table-bordered>tbody>tr>td:first-child,.panel>.table-responsive>.table-bordered>tbody>tr>th:first-child,.panel>.table-responsive>.table-bordered>tfoot>tr>td:first-child,.panel>.table-responsive>.table-bordered>tfoot>tr>th:first-child,.panel>.table-responsive>.table-bordered>thead>tr>td:first-child,.panel>.table-responsive>.table-bordered>thead>tr>th:first-child{border-left:0}.panel>.table-bordered>tbody>tr>td:last-child,.panel>.table-bordered>tbody>tr>th:last-child,.panel>.table-bordered>tfoot>tr>td:last-child,.panel>.table-bordered>tfoot>tr>th:last-child,.panel>.table-bordered>thead>tr>td:last-child,.panel>.table-bordered>thead>tr>th:last-child,.panel>.table-responsive>.table-bordered>tbody>tr>td:last-child,.panel>.table-responsive>.table-bordered>tbody>tr>th:last-child,.panel>.table-responsive>.table-bordered>tfoot>tr>td:last-child,.panel>.table-responsive>.table-bordered>tfoot>tr>th:last-child,.panel>.table-responsive>.table-bordered>thead>tr>td:last-child,.panel>.table-responsive>.table-bordered>thead>tr>th:last-child{border-right:0}.panel>.table-bordered>tbody>tr:first-child>td,.panel>.table-bordered>tbody>tr:first-child>th,.panel>.table-bordered>thead>tr:first-child>td,.panel>.table-bordered>thead>tr:first-child>th,.panel>.table-responsive>.table-bordered>tbody>tr:first-child>td,.panel>.table-responsive>.table-bordered>tbody>tr:first-child>th,.panel>.table-responsive>.table-bordered>thead>tr:first-child>td,.panel>.table-responsive>.table-bordered>thead>tr:first-child>th{border-bottom:0}.panel>.table-bordered>tbody>tr:last-child>td,.panel>.table-bordered>tbody>tr:last-child>th,.panel>.table-bordered>tfoot>tr:last-child>td,.panel>.table-bordered>tfoot>tr:last-child>th,.panel>.table-responsive>.table-bordered>tbody>tr:last-child>td,.panel>.table-responsive>.table-bordered>tbody>tr:last-child>th,.panel>.table-responsive>.table-bordered>tfoot>tr:last-child>td,.panel>.table-responsive>.table-bordered>tfoot>tr:last-child>th{border-bottom:0}.panel>.table-responsive{margin-bottom:0;border:0}.panel-group{margin-bottom:20px}.panel-group .panel{margin-bottom:0;border-radius:4px}.panel-group .panel+.panel{margin-top:5px}.panel-group .panel-heading{border-bottom:0}.panel-group .panel-heading+.panel-collapse>.list-group,.panel-group .panel-heading+.panel-collapse>.panel-body{border-top:1px solid #ddd}.panel-group .panel-footer{border-top:0}.panel-group .panel-footer+.panel-collapse .panel-body{border-bottom:1px solid #ddd}.panel-default{border-color:#ddd}.panel-default>.panel-heading{color:#333;background-color:#f5f5f5;border-color:#ddd}.panel-default>.panel-heading+.panel-collapse>.panel-body{border-top-color:#ddd}.panel-default>.panel-heading .badge{color:#f5f5f5;background-color:#333}.panel-default>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#ddd}.panel-primary{border-color:#337ab7}.panel-primary>.panel-heading{color:#fff;background-color:#337ab7;border-color:#337ab7}.panel-primary>.panel-heading+.panel-collapse>.panel-body{border-top-color:#337ab7}.panel-primary>.panel-heading .badge{color:#337ab7;background-color:#fff}.panel-primary>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#337ab7}.panel-success{border-color:#d6e9c6}.panel-success>.panel-heading{color:#3c763d;background-color:#dff0d8;border-color:#d6e9c6}.panel-success>.panel-heading+.panel-collapse>.panel-body{border-top-color:#d6e9c6}.panel-success>.panel-heading .badge{color:#dff0d8;background-color:#3c763d}.panel-success>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#d6e9c6}.panel-info{border-color:#bce8f1}.panel-info>.panel-heading{color:#31708f;background-color:#d9edf7;border-color:#bce8f1}.panel-info>.panel-heading+.panel-collapse>.panel-body{border-top-color:#bce8f1}.panel-info>.panel-heading .badge{color:#d9edf7;background-color:#31708f}.panel-info>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#bce8f1}.panel-warning{border-color:#faebcc}.panel-warning>.panel-heading{color:#8a6d3b;background-color:#fcf8e3;border-color:#faebcc}.panel-warning>.panel-heading+.panel-collapse>.panel-body{border-top-color:#faebcc}.panel-warning>.panel-heading .badge{color:#fcf8e3;background-color:#8a6d3b}.panel-warning>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#faebcc}.panel-danger{border-color:#ebccd1}.panel-danger>.panel-heading{color:#a94442;background-color:#f2dede;border-color:#ebccd1}.panel-danger>.panel-heading+.panel-collapse>.panel-body{border-top-color:#ebccd1}.panel-danger>.panel-heading .badge{color:#f2dede;background-color:#a94442}.panel-danger>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#ebccd1}.embed-responsive{position:relative;display:block;height:0;padding:0;overflow:hidden}.embed-responsive .embed-responsive-item,.embed-responsive embed,.embed-responsive iframe,.embed-responsive object,.embed-responsive video{position:absolute;top:0;bottom:0;left:0;width:100%;height:100%;border:0}.embed-responsive-16by9{padding-bottom:56.25%}.embed-responsive-4by3{padding-bottom:75%}.well{min-height:20px;padding:19px;margin-bottom:20px;background-color:#f5f5f5;border:1px solid #e3e3e3;border-radius:4px;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.05);box-shadow:inset 0 1px 1px rgba(0,0,0,.05)}.well blockquote{border-color:#ddd;border-color:rgba(0,0,0,.15)}.well-lg{padding:24px;border-radius:6px}.well-sm{padding:9px;border-radius:3px}.close{float:right;font-size:21px;font-weight:700;line-height:1;color:#000;text-shadow:0 1px 0 #fff;filter:alpha(opacity=20);opacity:.2}.close:focus,.close:hover{color:#000;text-decoration:none;cursor:pointer;filter:alpha(opacity=50);opacity:.5}button.close{-webkit-appearance:none;padding:0;cursor:pointer;background:0 0;border:0}.modal-open{overflow:hidden}.modal{position:fixed;top:0;right:0;bottom:0;left:0;z-index:1050;display:none;overflow:hidden;-webkit-overflow-scrolling:touch;outline:0}.modal.fade .modal-dialog{-webkit-transition:-webkit-transform .3s ease-out;-o-transition:-o-transform .3s ease-out;transition:transform .3s ease-out;-webkit-transform:translate(0,-25%);-ms-transform:translate(0,-25%);-o-transform:translate(0,-25%);transform:translate(0,-25%)}.modal.in .modal-dialog{-webkit-transform:translate(0,0);-ms-transform:translate(0,0);-o-transform:translate(0,0);transform:translate(0,0)}.modal-open .modal{overflow-x:hidden;overflow-y:auto}.modal-dialog{position:relative;width:auto;margin:10px}.modal-content{position:relative;background-color:#fff;-webkit-background-clip:padding-box;background-clip:padding-box;border:1px solid #999;border:1px solid rgba(0,0,0,.2);border-radius:6px;outline:0;-webkit-box-shadow:0 3px 9px rgba(0,0,0,.5);box-shadow:0 3px 9px rgba(0,0,0,.5)}.modal-backdrop{position:fixed;top:0;right:0;bottom:0;left:0;z-index:1040;background-color:#000}.modal-backdrop.fade{filter:alpha(opacity=0);opacity:0}.modal-backdrop.in{filter:alpha(opacity=50);opacity:.5}.modal-header{padding:15px;border-bottom:1px solid #e5e5e5}.modal-header .close{margin-top:-2px}.modal-title{margin:0;line-height:1.42857143}.modal-body{position:relative;padding:15px}.modal-footer{padding:15px;text-align:right;border-top:1px solid #e5e5e5}.modal-footer .btn+.btn{margin-bottom:0;margin-left:5px}.modal-footer .btn-group .btn+.btn{margin-left:-1px}.modal-footer .btn-block+.btn-block{margin-left:0}.modal-scrollbar-measure{position:absolute;top:-9999px;width:50px;height:50px;overflow:scroll}@media (min-width:768px){.modal-dialog{width:600px;margin:30px auto}.modal-content{-webkit-box-shadow:0 5px 15px rgba(0,0,0,.5);box-shadow:0 5px 15px rgba(0,0,0,.5)}.modal-sm{width:300px}}@media (min-width:992px){.modal-lg{width:900px}}.tooltip{position:absolute;z-index:1070;display:block;font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-size:12px;font-style:normal;font-weight:400;line-height:1.42857143;text-align:left;text-align:start;text-decoration:none;text-shadow:none;text-transform:none;letter-spacing:normal;word-break:normal;word-spacing:normal;word-wrap:normal;white-space:normal;filter:alpha(opacity=0);opacity:0;line-break:auto}.tooltip.in{filter:alpha(opacity=90);opacity:.9}.tooltip.top{padding:5px 0;margin-top:-3px}.tooltip.right{padding:0 5px;margin-left:3px}.tooltip.bottom{padding:5px 0;margin-top:3px}.tooltip.left{padding:0 5px;margin-left:-3px}.tooltip-inner{max-width:200px;padding:3px 8px;color:#fff;text-align:center;background-color:#000;border-radius:4px}.tooltip-arrow{position:absolute;width:0;height:0;border-color:transparent;border-style:solid}.tooltip.top .tooltip-arrow{bottom:0;left:50%;margin-left:-5px;border-width:5px 5px 0;border-top-color:#000}.tooltip.top-left .tooltip-arrow{right:5px;bottom:0;margin-bottom:-5px;border-width:5px 5px 0;border-top-color:#000}.tooltip.top-right .tooltip-arrow{bottom:0;left:5px;margin-bottom:-5px;border-width:5px 5px 0;border-top-color:#000}.tooltip.right .tooltip-arrow{top:50%;left:0;margin-top:-5px;border-width:5px 5px 5px 0;border-right-color:#000}.tooltip.left .tooltip-arrow{top:50%;right:0;margin-top:-5px;border-width:5px 0 5px 5px;border-left-color:#000}.tooltip.bottom .tooltip-arrow{top:0;left:50%;margin-left:-5px;border-width:0 5px 5px;border-bottom-color:#000}.tooltip.bottom-left .tooltip-arrow{top:0;right:5px;margin-top:-5px;border-width:0 5px 5px;border-bottom-color:#000}.tooltip.bottom-right .tooltip-arrow{top:0;left:5px;margin-top:-5px;border-width:0 5px 5px;border-bottom-color:#000}.popover{position:absolute;top:0;left:0;z-index:1060;display:none;max-width:276px;padding:1px;font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-size:14px;font-style:normal;font-weight:400;line-height:1.42857143;text-align:left;text-align:start;text-decoration:none;text-shadow:none;text-transform:none;letter-spacing:normal;word-break:normal;word-spacing:normal;word-wrap:normal;white-space:normal;background-color:#fff;-webkit-background-clip:padding-box;background-clip:padding-box;border:1px solid #ccc;border:1px solid rgba(0,0,0,.2);border-radius:6px;-webkit-box-shadow:0 5px 10px rgba(0,0,0,.2);box-shadow:0 5px 10px rgba(0,0,0,.2);line-break:auto}.popover.top{margin-top:-10px}.popover.right{margin-left:10px}.popover.bottom{margin-top:10px}.popover.left{margin-left:-10px}.popover-title{padding:8px 14px;margin:0;font-size:14px;background-color:#f7f7f7;border-bottom:1px solid #ebebeb;border-radius:5px 5px 0 0}.popover-content{padding:9px 14px}.popover>.arrow,.popover>.arrow:after{position:absolute;display:block;width:0;height:0;border-color:transparent;border-style:solid}.popover>.arrow{border-width:11px}.popover>.arrow:after{content:"";border-width:10px}.popover.top>.arrow{bottom:-11px;left:50%;margin-left:-11px;border-top-color:#999;border-top-color:rgba(0,0,0,.25);border-bottom-width:0}.popover.top>.arrow:after{bottom:1px;margin-left:-10px;content:" ";border-top-color:#fff;border-bottom-width:0}.popover.right>.arrow{top:50%;left:-11px;margin-top:-11px;border-right-color:#999;border-right-color:rgba(0,0,0,.25);border-left-width:0}.popover.right>.arrow:after{bottom:-10px;left:1px;content:" ";border-right-color:#fff;border-left-width:0}.popover.bottom>.arrow{top:-11px;left:50%;margin-left:-11px;border-top-width:0;border-bottom-color:#999;border-bottom-color:rgba(0,0,0,.25)}.popover.bottom>.arrow:after{top:1px;margin-left:-10px;content:" ";border-top-width:0;border-bottom-color:#fff}.popover.left>.arrow{top:50%;right:-11px;margin-top:-11px;border-right-width:0;border-left-color:#999;border-left-color:rgba(0,0,0,.25)}.popover.left>.arrow:after{right:1px;bottom:-10px;content:" ";border-right-width:0;border-left-color:#fff}.carousel{position:relative}.carousel-inner{position:relative;width:100%;overflow:hidden}.carousel-inner>.item{position:relative;display:none;-webkit-transition:.6s ease-in-out left;-o-transition:.6s ease-in-out left;transition:.6s ease-in-out left}.carousel-inner>.item>a>img,.carousel-inner>.item>img{line-height:1}@media all and (transform-3d),(-webkit-transform-3d){.carousel-inner>.item{-webkit-transition:-webkit-transform .6s ease-in-out;-o-transition:-o-transform .6s ease-in-out;transition:transform .6s ease-in-out;-webkit-backface-visibility:hidden;backface-visibility:hidden;-webkit-perspective:1000px;perspective:1000px}.carousel-inner>.item.active.right,.carousel-inner>.item.next{left:0;-webkit-transform:translate3d(100%,0,0);transform:translate3d(100%,0,0)}.carousel-inner>.item.active.left,.carousel-inner>.item.prev{left:0;-webkit-transform:translate3d(-100%,0,0);transform:translate3d(-100%,0,0)}.carousel-inner>.item.active,.carousel-inner>.item.next.left,.carousel-inner>.item.prev.right{left:0;-webkit-transform:translate3d(0,0,0);transform:translate3d(0,0,0)}}.carousel-inner>.active,.carousel-inner>.next,.carousel-inner>.prev{display:block}.carousel-inner>.active{left:0}.carousel-inner>.next,.carousel-inner>.prev{position:absolute;top:0;width:100%}.carousel-inner>.next{left:100%}.carousel-inner>.prev{left:-100%}.carousel-inner>.next.left,.carousel-inner>.prev.right{left:0}.carousel-inner>.active.left{left:-100%}.carousel-inner>.active.right{left:100%}.carousel-control{position:absolute;top:0;bottom:0;left:0;width:15%;font-size:20px;color:#fff;text-align:center;text-shadow:0 1px 2px rgba(0,0,0,.6);background-color:rgba(0,0,0,0);filter:alpha(opacity=50);opacity:.5}.carousel-control.left{background-image:-webkit-linear-gradient(left,rgba(0,0,0,.5) 0,rgba(0,0,0,.0001) 100%);background-image:-o-linear-gradient(left,rgba(0,0,0,.5) 0,rgba(0,0,0,.0001) 100%);background-image:-webkit-gradient(linear,left top,right top,from(rgba(0,0,0,.5)),to(rgba(0,0,0,.0001)));background-image:linear-gradient(to right,rgba(0,0,0,.5) 0,rgba(0,0,0,.0001) 100%);filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#80000000', endColorstr='#00000000', GradientType=1);background-repeat:repeat-x}.carousel-control.right{right:0;left:auto;background-image:-webkit-linear-gradient(left,rgba(0,0,0,.0001) 0,rgba(0,0,0,.5) 100%);background-image:-o-linear-gradient(left,rgba(0,0,0,.0001) 0,rgba(0,0,0,.5) 100%);background-image:-webkit-gradient(linear,left top,right top,from(rgba(0,0,0,.0001)),to(rgba(0,0,0,.5)));background-image:linear-gradient(to right,rgba(0,0,0,.0001) 0,rgba(0,0,0,.5) 100%);filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#00000000', endColorstr='#80000000', GradientType=1);background-repeat:repeat-x}.carousel-control:focus,.carousel-control:hover{color:#fff;text-decoration:none;filter:alpha(opacity=90);outline:0;opacity:.9}.carousel-control .glyphicon-chevron-left,.carousel-control .glyphicon-chevron-right,.carousel-control .icon-next,.carousel-control .icon-prev{position:absolute;top:50%;z-index:5;display:inline-block;margin-top:-10px}.carousel-control .glyphicon-chevron-left,.carousel-control .icon-prev{left:50%;margin-left:-10px}.carousel-control .glyphicon-chevron-right,.carousel-control .icon-next{right:50%;margin-right:-10px}.carousel-control .icon-next,.carousel-control .icon-prev{width:20px;height:20px;font-family:serif;line-height:1}.carousel-control .icon-prev:before{content:'\2039'}.carousel-control .icon-next:before{content:'\203a'}.carousel-indicators{position:absolute;bottom:10px;left:50%;z-index:15;width:60%;padding-left:0;margin-left:-30%;text-align:center;list-style:none}.carousel-indicators li{display:inline-block;width:10px;height:10px;margin:1px;text-indent:-999px;cursor:pointer;background-color:#000\9;background-color:rgba(0,0,0,0);border:1px solid #fff;border-radius:10px}.carousel-indicators .active{width:12px;height:12px;margin:0;background-color:#fff}.carousel-caption{position:absolute;right:15%;bottom:20px;left:15%;z-index:10;padding-top:20px;padding-bottom:20px;color:#fff;text-align:center;text-shadow:0 1px 2px rgba(0,0,0,.6)}.carousel-caption .btn{text-shadow:none}@media screen and (min-width:768px){.carousel-control .glyphicon-chevron-left,.carousel-control .glyphicon-chevron-right,.carousel-control .icon-next,.carousel-control .icon-prev{width:30px;height:30px;margin-top:-10px;font-size:30px}.carousel-control .glyphicon-chevron-left,.carousel-control .icon-prev{margin-left:-10px}.carousel-control .glyphicon-chevron-right,.carousel-control .icon-next{margin-right:-10px}.carousel-caption{right:20%;left:20%;padding-bottom:30px}.carousel-indicators{bottom:20px}}.btn-group-vertical>.btn-group:after,.btn-group-vertical>.btn-group:before,.btn-toolbar:after,.btn-toolbar:before,.clearfix:after,.clearfix:before,.container-fluid:after,.container-fluid:before,.container:after,.container:before,.dl-horizontal dd:after,.dl-horizontal dd:before,.form-horizontal .form-group:after,.form-horizontal .form-group:before,.modal-footer:after,.modal-footer:before,.modal-header:after,.modal-header:before,.nav:after,.nav:before,.navbar-collapse:after,.navbar-collapse:before,.navbar-header:after,.navbar-header:before,.navbar:after,.navbar:before,.pager:after,.pager:before,.panel-body:after,.panel-body:before,.row:after,.row:before{display:table;content:" "}.btn-group-vertical>.btn-group:after,.btn-toolbar:after,.clearfix:after,.container-fluid:after,.container:after,.dl-horizontal dd:after,.form-horizontal .form-group:after,.modal-footer:after,.modal-header:after,.nav:after,.navbar-collapse:after,.navbar-header:after,.navbar:after,.pager:after,.panel-body:after,.row:after{clear:both}.center-block{display:block;margin-right:auto;margin-left:auto}.pull-right{float:right!important}.pull-left{float:left!important}.hide{display:none!important}.show{display:block!important}.invisible{visibility:hidden}.text-hide{font:0/0 a;color:transparent;text-shadow:none;background-color:transparent;border:0}.hidden{display:none!important}.affix{position:fixed}@-ms-viewport{width:device-width}.visible-lg,.visible-md,.visible-sm,.visible-xs{display:none!important}.visible-lg-block,.visible-lg-inline,.visible-lg-inline-block,.visible-md-block,.visible-md-inline,.visible-md-inline-block,.visible-sm-block,.visible-sm-inline,.visible-sm-inline-block,.visible-xs-block,.visible-xs-inline,.visible-xs-inline-block{display:none!important}@media (max-width:767px){.visible-xs{display:block!important}table.visible-xs{display:table!important}tr.visible-xs{display:table-row!important}td.visible-xs,th.visible-xs{display:table-cell!important}}@media (max-width:767px){.visible-xs-block{display:block!important}}@media (max-width:767px){.visible-xs-inline{display:inline!important}}@media (max-width:767px){.visible-xs-inline-block{display:inline-block!important}}@media (min-width:768px) and (max-width:991px){.visible-sm{display:block!important}table.visible-sm{display:table!important}tr.visible-sm{display:table-row!important}td.visible-sm,th.visible-sm{display:table-cell!important}}@media (min-width:768px) and (max-width:991px){.visible-sm-block{display:block!important}}@media (min-width:768px) and (max-width:991px){.visible-sm-inline{display:inline!important}}@media (min-width:768px) and (max-width:991px){.visible-sm-inline-block{display:inline-block!important}}@media (min-width:992px) and (max-width:1199px){.visible-md{display:block!important}table.visible-md{display:table!important}tr.visible-md{display:table-row!important}td.visible-md,th.visible-md{display:table-cell!important}}@media (min-width:992px) and (max-width:1199px){.visible-md-block{display:block!important}}@media (min-width:992px) and (max-width:1199px){.visible-md-inline{display:inline!important}}@media (min-width:992px) and (max-width:1199px){.visible-md-inline-block{display:inline-block!important}}@media (min-width:1200px){.visible-lg{display:block!important}table.visible-lg{display:table!important}tr.visible-lg{display:table-row!important}td.visible-lg,th.visible-lg{display:table-cell!important}}@media (min-width:1200px){.visible-lg-block{display:block!important}}@media (min-width:1200px){.visible-lg-inline{display:inline!important}}@media (min-width:1200px){.visible-lg-inline-block{display:inline-block!important}}@media (max-width:767px){.hidden-xs{display:none!important}}@media (min-width:768px) and (max-width:991px){.hidden-sm{display:none!important}}@media (min-width:992px) and (max-width:1199px){.hidden-md{display:none!important}}@media (min-width:1200px){.hidden-lg{display:none!important}}.visible-print{display:none!important}@media print{.visible-print{display:block!important}table.visible-print{display:table!important}tr.visible-print{display:table-row!important}td.visible-print,th.visible-print{display:table-cell!important}}.visible-print-block{display:none!important}@media print{.visible-print-block{display:block!important}}.visible-print-inline{display:none!important}@media print{.visible-print-inline{display:inline!important}}.visible-print-inline-block{display:none!important}@media print{.visible-print-inline-block{display:inline-block!important}}@media print{.hidden-print{display:none!important}} +/*# sourceMappingURL=bootstrap.min.css.map */ \ No newline at end of file diff --git a/backend/docs/vendor/bootstrap.min.js b/backend/docs/vendor/bootstrap.min.js new file mode 100644 index 00000000000..9bcd2fccaed --- /dev/null +++ b/backend/docs/vendor/bootstrap.min.js @@ -0,0 +1,7 @@ +/*! + * Bootstrap v3.3.7 (http://getbootstrap.com) + * Copyright 2011-2016 Twitter, Inc. + * Licensed under the MIT license + */ +if("undefined"==typeof jQuery)throw new Error("Bootstrap's JavaScript requires jQuery");+function(a){"use strict";var b=a.fn.jquery.split(" ")[0].split(".");if(b[0]<2&&b[1]<9||1==b[0]&&9==b[1]&&b[2]<1||b[0]>3)throw new Error("Bootstrap's JavaScript requires jQuery version 1.9.1 or higher, but lower than version 4")}(jQuery),+function(a){"use strict";function b(){var a=document.createElement("bootstrap"),b={WebkitTransition:"webkitTransitionEnd",MozTransition:"transitionend",OTransition:"oTransitionEnd otransitionend",transition:"transitionend"};for(var c in b)if(void 0!==a.style[c])return{end:b[c]};return!1}a.fn.emulateTransitionEnd=function(b){var c=!1,d=this;a(this).one("bsTransitionEnd",function(){c=!0});var e=function(){c||a(d).trigger(a.support.transition.end)};return setTimeout(e,b),this},a(function(){a.support.transition=b(),a.support.transition&&(a.event.special.bsTransitionEnd={bindType:a.support.transition.end,delegateType:a.support.transition.end,handle:function(b){if(a(b.target).is(this))return b.handleObj.handler.apply(this,arguments)}})})}(jQuery),+function(a){"use strict";function b(b){return this.each(function(){var c=a(this),e=c.data("bs.alert");e||c.data("bs.alert",e=new d(this)),"string"==typeof b&&e[b].call(c)})}var c='[data-dismiss="alert"]',d=function(b){a(b).on("click",c,this.close)};d.VERSION="3.3.7",d.TRANSITION_DURATION=150,d.prototype.close=function(b){function c(){g.detach().trigger("closed.bs.alert").remove()}var e=a(this),f=e.attr("data-target");f||(f=e.attr("href"),f=f&&f.replace(/.*(?=#[^\s]*$)/,""));var g=a("#"===f?[]:f);b&&b.preventDefault(),g.length||(g=e.closest(".alert")),g.trigger(b=a.Event("close.bs.alert")),b.isDefaultPrevented()||(g.removeClass("in"),a.support.transition&&g.hasClass("fade")?g.one("bsTransitionEnd",c).emulateTransitionEnd(d.TRANSITION_DURATION):c())};var e=a.fn.alert;a.fn.alert=b,a.fn.alert.Constructor=d,a.fn.alert.noConflict=function(){return a.fn.alert=e,this},a(document).on("click.bs.alert.data-api",c,d.prototype.close)}(jQuery),+function(a){"use strict";function b(b){return this.each(function(){var d=a(this),e=d.data("bs.button"),f="object"==typeof b&&b;e||d.data("bs.button",e=new c(this,f)),"toggle"==b?e.toggle():b&&e.setState(b)})}var c=function(b,d){this.$element=a(b),this.options=a.extend({},c.DEFAULTS,d),this.isLoading=!1};c.VERSION="3.3.7",c.DEFAULTS={loadingText:"loading..."},c.prototype.setState=function(b){var c="disabled",d=this.$element,e=d.is("input")?"val":"html",f=d.data();b+="Text",null==f.resetText&&d.data("resetText",d[e]()),setTimeout(a.proxy(function(){d[e](null==f[b]?this.options[b]:f[b]),"loadingText"==b?(this.isLoading=!0,d.addClass(c).attr(c,c).prop(c,!0)):this.isLoading&&(this.isLoading=!1,d.removeClass(c).removeAttr(c).prop(c,!1))},this),0)},c.prototype.toggle=function(){var a=!0,b=this.$element.closest('[data-toggle="buttons"]');if(b.length){var c=this.$element.find("input");"radio"==c.prop("type")?(c.prop("checked")&&(a=!1),b.find(".active").removeClass("active"),this.$element.addClass("active")):"checkbox"==c.prop("type")&&(c.prop("checked")!==this.$element.hasClass("active")&&(a=!1),this.$element.toggleClass("active")),c.prop("checked",this.$element.hasClass("active")),a&&c.trigger("change")}else this.$element.attr("aria-pressed",!this.$element.hasClass("active")),this.$element.toggleClass("active")};var d=a.fn.button;a.fn.button=b,a.fn.button.Constructor=c,a.fn.button.noConflict=function(){return a.fn.button=d,this},a(document).on("click.bs.button.data-api",'[data-toggle^="button"]',function(c){var d=a(c.target).closest(".btn");b.call(d,"toggle"),a(c.target).is('input[type="radio"], input[type="checkbox"]')||(c.preventDefault(),d.is("input,button")?d.trigger("focus"):d.find("input:visible,button:visible").first().trigger("focus"))}).on("focus.bs.button.data-api blur.bs.button.data-api",'[data-toggle^="button"]',function(b){a(b.target).closest(".btn").toggleClass("focus",/^focus(in)?$/.test(b.type))})}(jQuery),+function(a){"use strict";function b(b){return this.each(function(){var d=a(this),e=d.data("bs.carousel"),f=a.extend({},c.DEFAULTS,d.data(),"object"==typeof b&&b),g="string"==typeof b?b:f.slide;e||d.data("bs.carousel",e=new c(this,f)),"number"==typeof b?e.to(b):g?e[g]():f.interval&&e.pause().cycle()})}var c=function(b,c){this.$element=a(b),this.$indicators=this.$element.find(".carousel-indicators"),this.options=c,this.paused=null,this.sliding=null,this.interval=null,this.$active=null,this.$items=null,this.options.keyboard&&this.$element.on("keydown.bs.carousel",a.proxy(this.keydown,this)),"hover"==this.options.pause&&!("ontouchstart"in document.documentElement)&&this.$element.on("mouseenter.bs.carousel",a.proxy(this.pause,this)).on("mouseleave.bs.carousel",a.proxy(this.cycle,this))};c.VERSION="3.3.7",c.TRANSITION_DURATION=600,c.DEFAULTS={interval:5e3,pause:"hover",wrap:!0,keyboard:!0},c.prototype.keydown=function(a){if(!/input|textarea/i.test(a.target.tagName)){switch(a.which){case 37:this.prev();break;case 39:this.next();break;default:return}a.preventDefault()}},c.prototype.cycle=function(b){return b||(this.paused=!1),this.interval&&clearInterval(this.interval),this.options.interval&&!this.paused&&(this.interval=setInterval(a.proxy(this.next,this),this.options.interval)),this},c.prototype.getItemIndex=function(a){return this.$items=a.parent().children(".item"),this.$items.index(a||this.$active)},c.prototype.getItemForDirection=function(a,b){var c=this.getItemIndex(b),d="prev"==a&&0===c||"next"==a&&c==this.$items.length-1;if(d&&!this.options.wrap)return b;var e="prev"==a?-1:1,f=(c+e)%this.$items.length;return this.$items.eq(f)},c.prototype.to=function(a){var b=this,c=this.getItemIndex(this.$active=this.$element.find(".item.active"));if(!(a>this.$items.length-1||a<0))return this.sliding?this.$element.one("slid.bs.carousel",function(){b.to(a)}):c==a?this.pause().cycle():this.slide(a>c?"next":"prev",this.$items.eq(a))},c.prototype.pause=function(b){return b||(this.paused=!0),this.$element.find(".next, .prev").length&&a.support.transition&&(this.$element.trigger(a.support.transition.end),this.cycle(!0)),this.interval=clearInterval(this.interval),this},c.prototype.next=function(){if(!this.sliding)return this.slide("next")},c.prototype.prev=function(){if(!this.sliding)return this.slide("prev")},c.prototype.slide=function(b,d){var e=this.$element.find(".item.active"),f=d||this.getItemForDirection(b,e),g=this.interval,h="next"==b?"left":"right",i=this;if(f.hasClass("active"))return this.sliding=!1;var j=f[0],k=a.Event("slide.bs.carousel",{relatedTarget:j,direction:h});if(this.$element.trigger(k),!k.isDefaultPrevented()){if(this.sliding=!0,g&&this.pause(),this.$indicators.length){this.$indicators.find(".active").removeClass("active");var l=a(this.$indicators.children()[this.getItemIndex(f)]);l&&l.addClass("active")}var m=a.Event("slid.bs.carousel",{relatedTarget:j,direction:h});return a.support.transition&&this.$element.hasClass("slide")?(f.addClass(b),f[0].offsetWidth,e.addClass(h),f.addClass(h),e.one("bsTransitionEnd",function(){f.removeClass([b,h].join(" ")).addClass("active"),e.removeClass(["active",h].join(" ")),i.sliding=!1,setTimeout(function(){i.$element.trigger(m)},0)}).emulateTransitionEnd(c.TRANSITION_DURATION)):(e.removeClass("active"),f.addClass("active"),this.sliding=!1,this.$element.trigger(m)),g&&this.cycle(),this}};var d=a.fn.carousel;a.fn.carousel=b,a.fn.carousel.Constructor=c,a.fn.carousel.noConflict=function(){return a.fn.carousel=d,this};var e=function(c){var d,e=a(this),f=a(e.attr("data-target")||(d=e.attr("href"))&&d.replace(/.*(?=#[^\s]+$)/,""));if(f.hasClass("carousel")){var g=a.extend({},f.data(),e.data()),h=e.attr("data-slide-to");h&&(g.interval=!1),b.call(f,g),h&&f.data("bs.carousel").to(h),c.preventDefault()}};a(document).on("click.bs.carousel.data-api","[data-slide]",e).on("click.bs.carousel.data-api","[data-slide-to]",e),a(window).on("load",function(){a('[data-ride="carousel"]').each(function(){var c=a(this);b.call(c,c.data())})})}(jQuery),+function(a){"use strict";function b(b){var c,d=b.attr("data-target")||(c=b.attr("href"))&&c.replace(/.*(?=#[^\s]+$)/,"");return a(d)}function c(b){return this.each(function(){var c=a(this),e=c.data("bs.collapse"),f=a.extend({},d.DEFAULTS,c.data(),"object"==typeof b&&b);!e&&f.toggle&&/show|hide/.test(b)&&(f.toggle=!1),e||c.data("bs.collapse",e=new d(this,f)),"string"==typeof b&&e[b]()})}var d=function(b,c){this.$element=a(b),this.options=a.extend({},d.DEFAULTS,c),this.$trigger=a('[data-toggle="collapse"][href="#'+b.id+'"],[data-toggle="collapse"][data-target="#'+b.id+'"]'),this.transitioning=null,this.options.parent?this.$parent=this.getParent():this.addAriaAndCollapsedClass(this.$element,this.$trigger),this.options.toggle&&this.toggle()};d.VERSION="3.3.7",d.TRANSITION_DURATION=350,d.DEFAULTS={toggle:!0},d.prototype.dimension=function(){var a=this.$element.hasClass("width");return a?"width":"height"},d.prototype.show=function(){if(!this.transitioning&&!this.$element.hasClass("in")){var b,e=this.$parent&&this.$parent.children(".panel").children(".in, .collapsing");if(!(e&&e.length&&(b=e.data("bs.collapse"),b&&b.transitioning))){var f=a.Event("show.bs.collapse");if(this.$element.trigger(f),!f.isDefaultPrevented()){e&&e.length&&(c.call(e,"hide"),b||e.data("bs.collapse",null));var g=this.dimension();this.$element.removeClass("collapse").addClass("collapsing")[g](0).attr("aria-expanded",!0),this.$trigger.removeClass("collapsed").attr("aria-expanded",!0),this.transitioning=1;var h=function(){this.$element.removeClass("collapsing").addClass("collapse in")[g](""),this.transitioning=0,this.$element.trigger("shown.bs.collapse")};if(!a.support.transition)return h.call(this);var i=a.camelCase(["scroll",g].join("-"));this.$element.one("bsTransitionEnd",a.proxy(h,this)).emulateTransitionEnd(d.TRANSITION_DURATION)[g](this.$element[0][i])}}}},d.prototype.hide=function(){if(!this.transitioning&&this.$element.hasClass("in")){var b=a.Event("hide.bs.collapse");if(this.$element.trigger(b),!b.isDefaultPrevented()){var c=this.dimension();this.$element[c](this.$element[c]())[0].offsetHeight,this.$element.addClass("collapsing").removeClass("collapse in").attr("aria-expanded",!1),this.$trigger.addClass("collapsed").attr("aria-expanded",!1),this.transitioning=1;var e=function(){this.transitioning=0,this.$element.removeClass("collapsing").addClass("collapse").trigger("hidden.bs.collapse")};return a.support.transition?void this.$element[c](0).one("bsTransitionEnd",a.proxy(e,this)).emulateTransitionEnd(d.TRANSITION_DURATION):e.call(this)}}},d.prototype.toggle=function(){this[this.$element.hasClass("in")?"hide":"show"]()},d.prototype.getParent=function(){return a(this.options.parent).find('[data-toggle="collapse"][data-parent="'+this.options.parent+'"]').each(a.proxy(function(c,d){var e=a(d);this.addAriaAndCollapsedClass(b(e),e)},this)).end()},d.prototype.addAriaAndCollapsedClass=function(a,b){var c=a.hasClass("in");a.attr("aria-expanded",c),b.toggleClass("collapsed",!c).attr("aria-expanded",c)};var e=a.fn.collapse;a.fn.collapse=c,a.fn.collapse.Constructor=d,a.fn.collapse.noConflict=function(){return a.fn.collapse=e,this},a(document).on("click.bs.collapse.data-api",'[data-toggle="collapse"]',function(d){var e=a(this);e.attr("data-target")||d.preventDefault();var f=b(e),g=f.data("bs.collapse"),h=g?"toggle":e.data();c.call(f,h)})}(jQuery),+function(a){"use strict";function b(b){var c=b.attr("data-target");c||(c=b.attr("href"),c=c&&/#[A-Za-z]/.test(c)&&c.replace(/.*(?=#[^\s]*$)/,""));var d=c&&a(c);return d&&d.length?d:b.parent()}function c(c){c&&3===c.which||(a(e).remove(),a(f).each(function(){var d=a(this),e=b(d),f={relatedTarget:this};e.hasClass("open")&&(c&&"click"==c.type&&/input|textarea/i.test(c.target.tagName)&&a.contains(e[0],c.target)||(e.trigger(c=a.Event("hide.bs.dropdown",f)),c.isDefaultPrevented()||(d.attr("aria-expanded","false"),e.removeClass("open").trigger(a.Event("hidden.bs.dropdown",f)))))}))}function d(b){return this.each(function(){var c=a(this),d=c.data("bs.dropdown");d||c.data("bs.dropdown",d=new g(this)),"string"==typeof b&&d[b].call(c)})}var e=".dropdown-backdrop",f='[data-toggle="dropdown"]',g=function(b){a(b).on("click.bs.dropdown",this.toggle)};g.VERSION="3.3.7",g.prototype.toggle=function(d){var e=a(this);if(!e.is(".disabled, :disabled")){var f=b(e),g=f.hasClass("open");if(c(),!g){"ontouchstart"in document.documentElement&&!f.closest(".navbar-nav").length&&a(document.createElement("div")).addClass("dropdown-backdrop").insertAfter(a(this)).on("click",c);var h={relatedTarget:this};if(f.trigger(d=a.Event("show.bs.dropdown",h)),d.isDefaultPrevented())return;e.trigger("focus").attr("aria-expanded","true"),f.toggleClass("open").trigger(a.Event("shown.bs.dropdown",h))}return!1}},g.prototype.keydown=function(c){if(/(38|40|27|32)/.test(c.which)&&!/input|textarea/i.test(c.target.tagName)){var d=a(this);if(c.preventDefault(),c.stopPropagation(),!d.is(".disabled, :disabled")){var e=b(d),g=e.hasClass("open");if(!g&&27!=c.which||g&&27==c.which)return 27==c.which&&e.find(f).trigger("focus"),d.trigger("click");var h=" li:not(.disabled):visible a",i=e.find(".dropdown-menu"+h);if(i.length){var j=i.index(c.target);38==c.which&&j>0&&j--,40==c.which&&jdocument.documentElement.clientHeight;this.$element.css({paddingLeft:!this.bodyIsOverflowing&&a?this.scrollbarWidth:"",paddingRight:this.bodyIsOverflowing&&!a?this.scrollbarWidth:""})},c.prototype.resetAdjustments=function(){this.$element.css({paddingLeft:"",paddingRight:""})},c.prototype.checkScrollbar=function(){var a=window.innerWidth;if(!a){var b=document.documentElement.getBoundingClientRect();a=b.right-Math.abs(b.left)}this.bodyIsOverflowing=document.body.clientWidth
',trigger:"hover focus",title:"",delay:0,html:!1,container:!1,viewport:{selector:"body",padding:0}},c.prototype.init=function(b,c,d){if(this.enabled=!0,this.type=b,this.$element=a(c),this.options=this.getOptions(d),this.$viewport=this.options.viewport&&a(a.isFunction(this.options.viewport)?this.options.viewport.call(this,this.$element):this.options.viewport.selector||this.options.viewport),this.inState={click:!1,hover:!1,focus:!1},this.$element[0]instanceof document.constructor&&!this.options.selector)throw new Error("`selector` option must be specified when initializing "+this.type+" on the window.document object!");for(var e=this.options.trigger.split(" "),f=e.length;f--;){var g=e[f];if("click"==g)this.$element.on("click."+this.type,this.options.selector,a.proxy(this.toggle,this));else if("manual"!=g){var h="hover"==g?"mouseenter":"focusin",i="hover"==g?"mouseleave":"focusout";this.$element.on(h+"."+this.type,this.options.selector,a.proxy(this.enter,this)),this.$element.on(i+"."+this.type,this.options.selector,a.proxy(this.leave,this))}}this.options.selector?this._options=a.extend({},this.options,{trigger:"manual",selector:""}):this.fixTitle()},c.prototype.getDefaults=function(){return c.DEFAULTS},c.prototype.getOptions=function(b){return b=a.extend({},this.getDefaults(),this.$element.data(),b),b.delay&&"number"==typeof b.delay&&(b.delay={show:b.delay,hide:b.delay}),b},c.prototype.getDelegateOptions=function(){var b={},c=this.getDefaults();return this._options&&a.each(this._options,function(a,d){c[a]!=d&&(b[a]=d)}),b},c.prototype.enter=function(b){var c=b instanceof this.constructor?b:a(b.currentTarget).data("bs."+this.type);return c||(c=new this.constructor(b.currentTarget,this.getDelegateOptions()),a(b.currentTarget).data("bs."+this.type,c)),b instanceof a.Event&&(c.inState["focusin"==b.type?"focus":"hover"]=!0),c.tip().hasClass("in")||"in"==c.hoverState?void(c.hoverState="in"):(clearTimeout(c.timeout),c.hoverState="in",c.options.delay&&c.options.delay.show?void(c.timeout=setTimeout(function(){"in"==c.hoverState&&c.show()},c.options.delay.show)):c.show())},c.prototype.isInStateTrue=function(){for(var a in this.inState)if(this.inState[a])return!0;return!1},c.prototype.leave=function(b){var c=b instanceof this.constructor?b:a(b.currentTarget).data("bs."+this.type);if(c||(c=new this.constructor(b.currentTarget,this.getDelegateOptions()),a(b.currentTarget).data("bs."+this.type,c)),b instanceof a.Event&&(c.inState["focusout"==b.type?"focus":"hover"]=!1),!c.isInStateTrue())return clearTimeout(c.timeout),c.hoverState="out",c.options.delay&&c.options.delay.hide?void(c.timeout=setTimeout(function(){"out"==c.hoverState&&c.hide()},c.options.delay.hide)):c.hide()},c.prototype.show=function(){var b=a.Event("show.bs."+this.type);if(this.hasContent()&&this.enabled){this.$element.trigger(b);var d=a.contains(this.$element[0].ownerDocument.documentElement,this.$element[0]);if(b.isDefaultPrevented()||!d)return;var e=this,f=this.tip(),g=this.getUID(this.type);this.setContent(),f.attr("id",g),this.$element.attr("aria-describedby",g),this.options.animation&&f.addClass("fade");var h="function"==typeof this.options.placement?this.options.placement.call(this,f[0],this.$element[0]):this.options.placement,i=/\s?auto?\s?/i,j=i.test(h);j&&(h=h.replace(i,"")||"top"),f.detach().css({top:0,left:0,display:"block"}).addClass(h).data("bs."+this.type,this),this.options.container?f.appendTo(this.options.container):f.insertAfter(this.$element),this.$element.trigger("inserted.bs."+this.type);var k=this.getPosition(),l=f[0].offsetWidth,m=f[0].offsetHeight;if(j){var n=h,o=this.getPosition(this.$viewport);h="bottom"==h&&k.bottom+m>o.bottom?"top":"top"==h&&k.top-mo.width?"left":"left"==h&&k.left-lg.top+g.height&&(e.top=g.top+g.height-i)}else{var j=b.left-f,k=b.left+f+c;jg.right&&(e.left=g.left+g.width-k)}return e},c.prototype.getTitle=function(){var a,b=this.$element,c=this.options;return a=b.attr("data-original-title")||("function"==typeof c.title?c.title.call(b[0]):c.title)},c.prototype.getUID=function(a){do a+=~~(1e6*Math.random());while(document.getElementById(a));return a},c.prototype.tip=function(){if(!this.$tip&&(this.$tip=a(this.options.template),1!=this.$tip.length))throw new Error(this.type+" `template` option must consist of exactly 1 top-level element!");return this.$tip},c.prototype.arrow=function(){return this.$arrow=this.$arrow||this.tip().find(".tooltip-arrow")},c.prototype.enable=function(){this.enabled=!0},c.prototype.disable=function(){this.enabled=!1},c.prototype.toggleEnabled=function(){this.enabled=!this.enabled},c.prototype.toggle=function(b){var c=this;b&&(c=a(b.currentTarget).data("bs."+this.type),c||(c=new this.constructor(b.currentTarget,this.getDelegateOptions()),a(b.currentTarget).data("bs."+this.type,c))),b?(c.inState.click=!c.inState.click,c.isInStateTrue()?c.enter(c):c.leave(c)):c.tip().hasClass("in")?c.leave(c):c.enter(c)},c.prototype.destroy=function(){var a=this;clearTimeout(this.timeout),this.hide(function(){a.$element.off("."+a.type).removeData("bs."+a.type),a.$tip&&a.$tip.detach(),a.$tip=null,a.$arrow=null,a.$viewport=null,a.$element=null})};var d=a.fn.tooltip;a.fn.tooltip=b,a.fn.tooltip.Constructor=c,a.fn.tooltip.noConflict=function(){return a.fn.tooltip=d,this}}(jQuery),+function(a){"use strict";function b(b){return this.each(function(){var d=a(this),e=d.data("bs.popover"),f="object"==typeof b&&b;!e&&/destroy|hide/.test(b)||(e||d.data("bs.popover",e=new c(this,f)),"string"==typeof b&&e[b]())})}var c=function(a,b){this.init("popover",a,b)};if(!a.fn.tooltip)throw new Error("Popover requires tooltip.js");c.VERSION="3.3.7",c.DEFAULTS=a.extend({},a.fn.tooltip.Constructor.DEFAULTS,{placement:"right",trigger:"click",content:"",template:''}),c.prototype=a.extend({},a.fn.tooltip.Constructor.prototype),c.prototype.constructor=c,c.prototype.getDefaults=function(){return c.DEFAULTS},c.prototype.setContent=function(){var a=this.tip(),b=this.getTitle(),c=this.getContent();a.find(".popover-title")[this.options.html?"html":"text"](b),a.find(".popover-content").children().detach().end()[this.options.html?"string"==typeof c?"html":"append":"text"](c),a.removeClass("fade top bottom left right in"),a.find(".popover-title").html()||a.find(".popover-title").hide()},c.prototype.hasContent=function(){return this.getTitle()||this.getContent()},c.prototype.getContent=function(){var a=this.$element,b=this.options;return a.attr("data-content")||("function"==typeof b.content?b.content.call(a[0]):b.content)},c.prototype.arrow=function(){return this.$arrow=this.$arrow||this.tip().find(".arrow")};var d=a.fn.popover;a.fn.popover=b,a.fn.popover.Constructor=c,a.fn.popover.noConflict=function(){return a.fn.popover=d,this}}(jQuery),+function(a){"use strict";function b(c,d){this.$body=a(document.body),this.$scrollElement=a(a(c).is(document.body)?window:c),this.options=a.extend({},b.DEFAULTS,d),this.selector=(this.options.target||"")+" .nav li > a",this.offsets=[],this.targets=[],this.activeTarget=null,this.scrollHeight=0,this.$scrollElement.on("scroll.bs.scrollspy",a.proxy(this.process,this)),this.refresh(),this.process()}function c(c){return this.each(function(){var d=a(this),e=d.data("bs.scrollspy"),f="object"==typeof c&&c;e||d.data("bs.scrollspy",e=new b(this,f)),"string"==typeof c&&e[c]()})}b.VERSION="3.3.7",b.DEFAULTS={offset:10},b.prototype.getScrollHeight=function(){return this.$scrollElement[0].scrollHeight||Math.max(this.$body[0].scrollHeight,document.documentElement.scrollHeight)},b.prototype.refresh=function(){var b=this,c="offset",d=0;this.offsets=[],this.targets=[],this.scrollHeight=this.getScrollHeight(),a.isWindow(this.$scrollElement[0])||(c="position",d=this.$scrollElement.scrollTop()),this.$body.find(this.selector).map(function(){var b=a(this),e=b.data("target")||b.attr("href"),f=/^#./.test(e)&&a(e);return f&&f.length&&f.is(":visible")&&[[f[c]().top+d,e]]||null}).sort(function(a,b){return a[0]-b[0]}).each(function(){b.offsets.push(this[0]),b.targets.push(this[1])})},b.prototype.process=function(){var a,b=this.$scrollElement.scrollTop()+this.options.offset,c=this.getScrollHeight(),d=this.options.offset+c-this.$scrollElement.height(),e=this.offsets,f=this.targets,g=this.activeTarget;if(this.scrollHeight!=c&&this.refresh(),b>=d)return g!=(a=f[f.length-1])&&this.activate(a);if(g&&b=e[a]&&(void 0===e[a+1]||b .dropdown-menu > .active").removeClass("active").end().find('[data-toggle="tab"]').attr("aria-expanded",!1),b.addClass("active").find('[data-toggle="tab"]').attr("aria-expanded",!0),h?(b[0].offsetWidth,b.addClass("in")):b.removeClass("fade"),b.parent(".dropdown-menu").length&&b.closest("li.dropdown").addClass("active").end().find('[data-toggle="tab"]').attr("aria-expanded",!0),e&&e()}var g=d.find("> .active"),h=e&&a.support.transition&&(g.length&&g.hasClass("fade")||!!d.find("> .fade").length);g.length&&h?g.one("bsTransitionEnd",f).emulateTransitionEnd(c.TRANSITION_DURATION):f(),g.removeClass("in")};var d=a.fn.tab;a.fn.tab=b,a.fn.tab.Constructor=c,a.fn.tab.noConflict=function(){return a.fn.tab=d,this};var e=function(c){c.preventDefault(),b.call(a(this),"show")};a(document).on("click.bs.tab.data-api",'[data-toggle="tab"]',e).on("click.bs.tab.data-api",'[data-toggle="pill"]',e)}(jQuery),+function(a){"use strict";function b(b){return this.each(function(){var d=a(this),e=d.data("bs.affix"),f="object"==typeof b&&b;e||d.data("bs.affix",e=new c(this,f)),"string"==typeof b&&e[b]()})}var c=function(b,d){this.options=a.extend({},c.DEFAULTS,d),this.$target=a(this.options.target).on("scroll.bs.affix.data-api",a.proxy(this.checkPosition,this)).on("click.bs.affix.data-api",a.proxy(this.checkPositionWithEventLoop,this)),this.$element=a(b),this.affixed=null,this.unpin=null,this.pinnedOffset=null,this.checkPosition()};c.VERSION="3.3.7",c.RESET="affix affix-top affix-bottom",c.DEFAULTS={offset:0,target:window},c.prototype.getState=function(a,b,c,d){var e=this.$target.scrollTop(),f=this.$element.offset(),g=this.$target.height();if(null!=c&&"top"==this.affixed)return e=a-d&&"bottom"},c.prototype.getPinnedOffset=function(){if(this.pinnedOffset)return this.pinnedOffset;this.$element.removeClass(c.RESET).addClass("affix");var a=this.$target.scrollTop(),b=this.$element.offset();return this.pinnedOffset=b.top-a},c.prototype.checkPositionWithEventLoop=function(){setTimeout(a.proxy(this.checkPosition,this),1)},c.prototype.checkPosition=function(){if(this.$element.is(":visible")){var b=this.$element.height(),d=this.options.offset,e=d.top,f=d.bottom,g=Math.max(a(document).height(),a(document.body).height());"object"!=typeof d&&(f=e=d),"function"==typeof e&&(e=d.top(this.$element)),"function"==typeof f&&(f=d.bottom(this.$element));var h=this.getState(g,b,e,f);if(this.affixed!=h){null!=this.unpin&&this.$element.css("top","");var i="affix"+(h?"-"+h:""),j=a.Event(i+".bs.affix");if(this.$element.trigger(j),j.isDefaultPrevented())return;this.affixed=h,this.unpin="bottom"==h?this.getPinnedOffset():null,this.$element.removeClass(c.RESET).addClass(i).trigger(i.replace("affix","affixed")+".bs.affix")}"bottom"==h&&this.$element.offset({top:g-b-f})}};var d=a.fn.affix;a.fn.affix=b,a.fn.affix.Constructor=c,a.fn.affix.noConflict=function(){return a.fn.affix=d,this},a(window).on("load",function(){a('[data-spy="affix"]').each(function(){var c=a(this),d=c.data();d.offset=d.offset||{},null!=d.offsetBottom&&(d.offset.bottom=d.offsetBottom),null!=d.offsetTop&&(d.offset.top=d.offsetTop),b.call(c,d)})})}(jQuery); \ No newline at end of file diff --git a/backend/docs/vendor/diff_match_patch.min.js b/backend/docs/vendor/diff_match_patch.min.js new file mode 100644 index 00000000000..c41b51327da --- /dev/null +++ b/backend/docs/vendor/diff_match_patch.min.js @@ -0,0 +1,49 @@ +(function(){function diff_match_patch(){this.Diff_Timeout=1;this.Diff_EditCost=4;this.Match_Threshold=0.5;this.Match_Distance=1E3;this.Patch_DeleteThreshold=0.5;this.Patch_Margin=4;this.Match_MaxBits=32} +diff_match_patch.prototype.diff_main=function(a,b,c,d){"undefined"==typeof d&&(d=0>=this.Diff_Timeout?Number.MAX_VALUE:(new Date).getTime()+1E3*this.Diff_Timeout);if(null==a||null==b)throw Error("Null input. (diff_main)");if(a==b)return a?[[0,a]]:[];"undefined"==typeof c&&(c=!0);var e=c,f=this.diff_commonPrefix(a,b);c=a.substring(0,f);a=a.substring(f);b=b.substring(f);var f=this.diff_commonSuffix(a,b),g=a.substring(a.length-f);a=a.substring(0,a.length-f);b=b.substring(0,b.length-f);a=this.diff_compute_(a, +b,e,d);c&&a.unshift([0,c]);g&&a.push([0,g]);this.diff_cleanupMerge(a);return a}; +diff_match_patch.prototype.diff_compute_=function(a,b,c,d){if(!a)return[[1,b]];if(!b)return[[-1,a]];var e=a.length>b.length?a:b,f=a.length>b.length?b:a,g=e.indexOf(f);return-1!=g?(c=[[1,e.substring(0,g)],[0,f],[1,e.substring(g+f.length)]],a.length>b.length&&(c[0][0]=c[2][0]=-1),c):1==f.length?[[-1,a],[1,b]]:(e=this.diff_halfMatch_(a,b))?(f=e[0],a=e[1],g=e[2],b=e[3],e=e[4],f=this.diff_main(f,g,c,d),c=this.diff_main(a,b,c,d),f.concat([[0,e]],c)):c&&100c);v++){for(var n=-v+r;n<=v-t;n+=2){var l=g+n,m;m=n==-v||n!=v&&j[l-1]d)t+=2;else if(s>e)r+=2;else if(q&&(l=g+k-n,0<=l&&l= +u)return this.diff_bisectSplit_(a,b,m,s,c)}}for(n=-v+p;n<=v-w;n+=2){l=g+n;u=n==-v||n!=v&&i[l-1]d)w+=2;else if(m>e)p+=2;else if(!q&&(l=g+k-n,0<=l&&(l=u)))return this.diff_bisectSplit_(a,b,m,s,c)}}return[[-1,a],[1,b]]}; +diff_match_patch.prototype.diff_bisectSplit_=function(a,b,c,d,e){var f=a.substring(0,c),g=b.substring(0,d);a=a.substring(c);b=b.substring(d);f=this.diff_main(f,g,!1,e);e=this.diff_main(a,b,!1,e);return f.concat(e)}; +diff_match_patch.prototype.diff_linesToChars_=function(a,b){function c(a){for(var b="",c=0,f=-1,g=d.length;fd?a=a.substring(c-d):c=a.length?[h,j,n,l,g]:null}if(0>=this.Diff_Timeout)return null; +var d=a.length>b.length?a:b,e=a.length>b.length?b:a;if(4>d.length||2*e.lengthd[4].length?g:d:d:g;var j;a.length>b.length?(g=h[0],d=h[1],e=h[2],j=h[3]):(e=h[0],j=h[1],g=h[2],d=h[3]);h=h[4];return[g,d,e,j,h]}; +diff_match_patch.prototype.diff_cleanupSemantic=function(a){for(var b=!1,c=[],d=0,e=null,f=0,g=0,h=0,j=0,i=0;f=e){if(d>=b.length/2||d>=c.length/2)a.splice(f,0,[0,c.substring(0,d)]),a[f-1][1]=b.substring(0,b.length-d),a[f+1][1]=c.substring(d),f++}else if(e>=b.length/2||e>=c.length/2)a.splice(f,0,[0,b.substring(0,e)]),a[f-1][0]=1,a[f-1][1]=c.substring(0,c.length-e),a[f+1][0]=-1,a[f+1][1]=b.substring(e),f++;f++}f++}}; +diff_match_patch.prototype.diff_cleanupSemanticLossless=function(a){function b(a,b){if(!a||!b)return 6;var c=a.charAt(a.length-1),d=b.charAt(0),e=c.match(diff_match_patch.nonAlphaNumericRegex_),f=d.match(diff_match_patch.nonAlphaNumericRegex_),g=e&&c.match(diff_match_patch.whitespaceRegex_),h=f&&d.match(diff_match_patch.whitespaceRegex_),c=g&&c.match(diff_match_patch.linebreakRegex_),d=h&&d.match(diff_match_patch.linebreakRegex_),i=c&&a.match(diff_match_patch.blanklineEndRegex_),j=d&&b.match(diff_match_patch.blanklineStartRegex_); +return i||j?5:c||d?4:e&&!g&&h?3:g||h?2:e||f?1:0}for(var c=1;c=i&&(i=k,g=d,h=e,j=f)}a[c-1][1]!=g&&(g?a[c-1][1]=g:(a.splice(c-1,1),c--),a[c][1]= +h,j?a[c+1][1]=j:(a.splice(c+1,1),c--))}c++}};diff_match_patch.nonAlphaNumericRegex_=/[^a-zA-Z0-9]/;diff_match_patch.whitespaceRegex_=/\s/;diff_match_patch.linebreakRegex_=/[\r\n]/;diff_match_patch.blanklineEndRegex_=/\n\r?\n$/;diff_match_patch.blanklineStartRegex_=/^\r?\n\r?\n/; +diff_match_patch.prototype.diff_cleanupEfficiency=function(a){for(var b=!1,c=[],d=0,e=null,f=0,g=!1,h=!1,j=!1,i=!1;fb)break;e=c;f=d}return a.length!=g&&-1===a[g][0]?f:f+(b-e)}; +diff_match_patch.prototype.diff_prettyHtml=function(a){for(var b=[],c=/&/g,d=//g,f=/\n/g,g=0;g");switch(h){case 1:b[g]=''+j+"";break;case -1:b[g]=''+j+"";break;case 0:b[g]=""+j+""}}return b.join("")}; +diff_match_patch.prototype.diff_text1=function(a){for(var b=[],c=0;cthis.Match_MaxBits)throw Error("Pattern too long for this browser.");var e=this.match_alphabet_(b),f=this,g=this.Match_Threshold,h=a.indexOf(b,c);-1!=h&&(g=Math.min(d(0,h),g),h=a.lastIndexOf(b,c+b.length),-1!=h&&(g=Math.min(d(0,h),g)));for(var j=1<=i;p--){var w=e[a.charAt(p-1)];k[p]=0===t?(k[p+1]<<1|1)&w:(k[p+1]<<1|1)&w|((r[p+1]|r[p])<<1|1)|r[p+1];if(k[p]&j&&(w=d(t,p-1),w<=g))if(g=w,h=p-1,h>c)i=Math.max(1,2*c-h);else break}if(d(t+1,c)>g)break;r=k}return h}; +diff_match_patch.prototype.match_alphabet_=function(a){for(var b={},c=0;c=2*this.Patch_Margin&& +e&&(this.patch_addContext_(a,h),c.push(a),a=new diff_match_patch.patch_obj,e=0,h=d,f=g)}1!==i&&(f+=k.length);-1!==i&&(g+=k.length)}e&&(this.patch_addContext_(a,h),c.push(a));return c};diff_match_patch.prototype.patch_deepCopy=function(a){for(var b=[],c=0;cthis.Match_MaxBits){if(j=this.match_main(b,h.substring(0,this.Match_MaxBits),g),-1!=j&&(i=this.match_main(b,h.substring(h.length-this.Match_MaxBits),g+h.length-this.Match_MaxBits),-1==i||j>=i))j=-1}else j=this.match_main(b,h,g); +if(-1==j)e[f]=!1,d-=a[f].length2-a[f].length1;else if(e[f]=!0,d=j-g,g=-1==i?b.substring(j,j+h.length):b.substring(j,i+this.Match_MaxBits),h==g)b=b.substring(0,j)+this.diff_text2(a[f].diffs)+b.substring(j+h.length);else if(g=this.diff_main(h,g,!1),h.length>this.Match_MaxBits&&this.diff_levenshtein(g)/h.length>this.Patch_DeleteThreshold)e[f]=!1;else{this.diff_cleanupSemanticLossless(g);for(var h=0,k,i=0;ie[0][1].length){var f=b-e[0][1].length;e[0][1]=c.substring(e[0][1].length)+e[0][1];d.start1-=f;d.start2-=f;d.length1+=f;d.length2+=f}d=a[a.length-1];e=d.diffs;0==e.length||0!=e[e.length-1][0]?(e.push([0, +c]),d.length1+=b,d.length2+=b):b>e[e.length-1][1].length&&(f=b-e[e.length-1][1].length,e[e.length-1][1]+=c.substring(0,f),d.length1+=f,d.length2+=f);return c}; +diff_match_patch.prototype.patch_splitMax=function(a){for(var b=this.Match_MaxBits,c=0;c2*b?(h.length1+=i.length,e+=i.length,j=!1,h.diffs.push([g,i]),d.diffs.shift()):(i=i.substring(0,b-h.length1-this.Patch_Margin),h.length1+=i.length,e+=i.length,0===g?(h.length2+=i.length,f+=i.length):j=!1,h.diffs.push([g,i]),i==d.diffs[0][1]?d.diffs.shift():d.diffs[0][1]=d.diffs[0][1].substring(i.length))}g=this.diff_text2(h.diffs);g=g.substring(g.length-this.Patch_Margin);i=this.diff_text1(d.diffs).substring(0,this.Patch_Margin);""!==i&& +(h.length1+=i.length,h.length2+=i.length,0!==h.diffs.length&&0===h.diffs[h.diffs.length-1][0]?h.diffs[h.diffs.length-1][1]+=i:h.diffs.push([0,i]));j||a.splice(++c,0,h)}}};diff_match_patch.prototype.patch_toText=function(a){for(var b=[],c=0;c= 2.0.0-beta.1",7:">= 4.0.0"};b.REVISION_CHANGES=o;var p="[object Object]";d.prototype={constructor:d,logger:l["default"],log:l["default"].log,registerHelper:function(a,b){if(f.toString.call(a)===p){if(b)throw new h["default"]("Arg not supported with multiple helpers");f.extend(this.helpers,a)}else this.helpers[a]=b},unregisterHelper:function(a){delete this.helpers[a]},registerPartial:function(a,b){if(f.toString.call(a)===p)f.extend(this.partials,a);else{if("undefined"==typeof b)throw new h["default"]('Attempting to register a partial called "'+a+'" as undefined');this.partials[a]=b}},unregisterPartial:function(a){delete this.partials[a]},registerDecorator:function(a,b){if(f.toString.call(a)===p){if(b)throw new h["default"]("Arg not supported with multiple decorators");f.extend(this.decorators,a)}else this.decorators[a]=b},unregisterDecorator:function(a){delete this.decorators[a]}};var q=l["default"].log;b.log=q,b.createFrame=f.createFrame,b.logger=l["default"]},function(a,b){"use strict";function c(a){return k[a]}function d(a){for(var b=1;bc;c++)if(a[c]===b)return c;return-1}function f(a){if("string"!=typeof a){if(a&&a.toHTML)return a.toHTML();if(null==a)return"";if(!a)return a+"";a=""+a}return m.test(a)?a.replace(l,c):a}function g(a){return a||0===a?p(a)&&0===a.length?!0:!1:!0}function h(a){var b=d({},a);return b._parent=a,b}function i(a,b){return a.path=b,a}function j(a,b){return(a?a+".":"")+b}b.__esModule=!0,b.extend=d,b.indexOf=e,b.escapeExpression=f,b.isEmpty=g,b.createFrame=h,b.blockParams=i,b.appendContextPath=j;var k={"&":"&","<":"<",">":">",'"':""","'":"'","`":"`","=":"="},l=/[&<>"'`=]/g,m=/[&<>"'`=]/,n=Object.prototype.toString;b.toString=n;var o=function(a){return"function"==typeof a};o(/x/)&&(b.isFunction=o=function(a){return"function"==typeof a&&"[object Function]"===n.call(a)}),b.isFunction=o;var p=Array.isArray||function(a){return a&&"object"==typeof a?"[object Array]"===n.call(a):!1};b.isArray=p},function(a,b){"use strict";function c(a,b){var e=b&&b.loc,f=void 0,g=void 0;e&&(f=e.start.line,g=e.start.column,a+=" - "+f+":"+g);for(var h=Error.prototype.constructor.call(this,a),i=0;i0?(c.ids&&(c.ids=[c.name]),a.helpers.each(b,c)):e(this);if(c.data&&c.ids){var g=d.createFrame(c.data);g.contextPath=d.appendContextPath(c.data.contextPath,c.name),c={data:g}}return f(b,c)})},a.exports=b["default"]},function(a,b,c){"use strict";var d=c(1)["default"];b.__esModule=!0;var e=c(5),f=c(6),g=d(f);b["default"]=function(a){a.registerHelper("each",function(a,b){function c(b,c,f){j&&(j.key=b,j.index=c,j.first=0===c,j.last=!!f,k&&(j.contextPath=k+b)),i+=d(a[b],{data:j,blockParams:e.blockParams([a[b],b],[k+b,null])})}if(!b)throw new g["default"]("Must pass iterator to #each");var d=b.fn,f=b.inverse,h=0,i="",j=void 0,k=void 0;if(b.data&&b.ids&&(k=e.appendContextPath(b.data.contextPath,b.ids[0])+"."),e.isFunction(a)&&(a=a.call(this)),b.data&&(j=e.createFrame(b.data)),a&&"object"==typeof a)if(e.isArray(a))for(var l=a.length;l>h;h++)h in a&&c(h,h,h===a.length-1);else{var m=void 0;for(var n in a)a.hasOwnProperty(n)&&(void 0!==m&&c(m,h-1),m=n,h++);void 0!==m&&c(m,h-1,!0)}return 0===h&&(i=f(this)),i})},a.exports=b["default"]},function(a,b,c){"use strict";var d=c(1)["default"];b.__esModule=!0;var e=c(6),f=d(e);b["default"]=function(a){a.registerHelper("helperMissing",function(){if(1!==arguments.length)throw new f["default"]('Missing helper: "'+arguments[arguments.length-1].name+'"')})},a.exports=b["default"]},function(a,b,c){"use strict";b.__esModule=!0;var d=c(5);b["default"]=function(a){a.registerHelper("if",function(a,b){return d.isFunction(a)&&(a=a.call(this)),!b.hash.includeZero&&!a||d.isEmpty(a)?b.inverse(this):b.fn(this)}),a.registerHelper("unless",function(b,c){return a.helpers["if"].call(this,b,{fn:c.inverse,inverse:c.fn,hash:c.hash})})},a.exports=b["default"]},function(a,b){"use strict";b.__esModule=!0,b["default"]=function(a){a.registerHelper("log",function(){for(var b=[void 0],c=arguments[arguments.length-1],d=0;d=0?b:parseInt(a,10)}return a},log:function(a){if(a=e.lookupLevel(a),"undefined"!=typeof console&&e.lookupLevel(e.level)<=a){var b=e.methodMap[a];console[b]||(b="log");for(var c=arguments.length,d=Array(c>1?c-1:0),f=1;c>f;f++)d[f-1]=arguments[f];console[b].apply(console,d)}}};b["default"]=e,a.exports=b["default"]},function(a,b){"use strict";function c(a){this.string=a}b.__esModule=!0,c.prototype.toString=c.prototype.toHTML=function(){return""+this.string},b["default"]=c,a.exports=b["default"]},function(a,b,c){"use strict";function d(a){var b=a&&a[0]||1,c=r.COMPILER_REVISION;if(b!==c){if(c>b){var d=r.REVISION_CHANGES[c],e=r.REVISION_CHANGES[b];throw new q["default"]("Template was precompiled with an older version of Handlebars than the current runtime. Please update your precompiler to a newer version ("+d+") or downgrade your runtime to an older version ("+e+").")}throw new q["default"]("Template was precompiled with a newer version of Handlebars than the current runtime. Please update your runtime to a newer version ("+a[1]+").")}}function e(a,b){function c(c,d,e){e.hash&&(d=o.extend({},d,e.hash),e.ids&&(e.ids[0]=!0)),c=b.VM.resolvePartial.call(this,c,d,e);var f=b.VM.invokePartial.call(this,c,d,e);if(null==f&&b.compile&&(e.partials[e.name]=b.compile(c,a.compilerOptions,b),f=e.partials[e.name](d,e)),null!=f){if(e.indent){for(var g=f.split("\n"),h=0,i=g.length;i>h&&(g[h]||h+1!==i);h++)g[h]=e.indent+g[h];f=g.join("\n")}return f}throw new q["default"]("The partial "+e.name+" could not be compiled when running in runtime-only mode")}function d(b){function c(b){return""+a.main(e,b,e.helpers,e.partials,g,i,h)}var f=arguments.length<=1||void 0===arguments[1]?{}:arguments[1],g=f.data;d._setup(f),!f.partial&&a.useData&&(g=j(b,g));var h=void 0,i=a.useBlockParams?[]:void 0;return a.useDepths&&(h=f.depths?b!==f.depths[0]?[b].concat(f.depths):f.depths:[b]),(c=k(a.main,c,e,f.depths||[],g,i))(b,f)}if(!b)throw new q["default"]("No environment passed to template");if(!a||!a.main)throw new q["default"]("Unknown template object: "+typeof a);a.main.decorator=a.main_d,b.VM.checkRevision(a.compiler);var e={strict:function(a,b){if(!(b in a))throw new q["default"]('"'+b+'" not defined in '+a);return a[b]},lookup:function(a,b){for(var c=a.length,d=0;c>d;d++)if(a[d]&&null!=a[d][b])return a[d][b]},lambda:function(a,b){return"function"==typeof a?a.call(b):a},escapeExpression:o.escapeExpression,invokePartial:c,fn:function(b){var c=a[b];return c.decorator=a[b+"_d"],c},programs:[],program:function(a,b,c,d,e){var g=this.programs[a],h=this.fn(a);return b||e||d||c?g=f(this,a,h,b,c,d,e):g||(g=this.programs[a]=f(this,a,h)),g},data:function(a,b){for(;a&&b--;)a=a._parent;return a},merge:function(a,b){var c=a||b;return a&&b&&a!==b&&(c=o.extend({},b,a)),c},noop:b.VM.noop,compilerInfo:a.compiler};return d.isTop=!0,d._setup=function(c){c.partial?(e.helpers=c.helpers,e.partials=c.partials,e.decorators=c.decorators):(e.helpers=e.merge(c.helpers,b.helpers),a.usePartial&&(e.partials=e.merge(c.partials,b.partials)),(a.usePartial||a.useDecorators)&&(e.decorators=e.merge(c.decorators,b.decorators)))},d._child=function(b,c,d,g){if(a.useBlockParams&&!d)throw new q["default"]("must pass block params");if(a.useDepths&&!g)throw new q["default"]("must pass parent depths");return f(e,b,a[b],c,0,d,g)},d}function f(a,b,c,d,e,f,g){function h(b){var e=arguments.length<=1||void 0===arguments[1]?{}:arguments[1],h=g;return g&&b!==g[0]&&(h=[b].concat(g)),c(a,b,a.helpers,a.partials,e.data||d,f&&[e.blockParams].concat(f),h)}return h=k(c,h,a,g,d,f),h.program=b,h.depth=g?g.length:0,h.blockParams=e||0,h}function g(a,b,c){return a?a.call||c.name||(c.name=a,a=c.partials[a]):a="@partial-block"===c.name?c.data["partial-block"]:c.partials[c.name],a}function h(a,b,c){c.partial=!0,c.ids&&(c.data.contextPath=c.ids[0]||c.data.contextPath);var d=void 0;if(c.fn&&c.fn!==i&&(c.data=r.createFrame(c.data),d=c.data["partial-block"]=c.fn,d.partials&&(c.partials=o.extend({},c.partials,d.partials))),void 0===a&&d&&(a=d),void 0===a)throw new q["default"]("The partial "+c.name+" could not be found");return a instanceof Function?a(b,c):void 0}function i(){return""}function j(a,b){return b&&"root"in b||(b=b?r.createFrame(b):{},b.root=a),b}function k(a,b,c,d,e,f){if(a.decorator){var g={};b=a.decorator(b,g,c,d&&d[0],e,f,d),o.extend(b,g)}return b}var l=c(3)["default"],m=c(1)["default"];b.__esModule=!0,b.checkRevision=d,b.template=e,b.wrapProgram=f,b.resolvePartial=g,b.invokePartial=h,b.noop=i;var n=c(5),o=l(n),p=c(6),q=m(p),r=c(4)},function(a,b){(function(c){"use strict";b.__esModule=!0,b["default"]=function(a){var b="undefined"!=typeof c?c:window,d=b.Handlebars;a.noConflict=function(){return b.Handlebars===a&&(b.Handlebars=d),a}},a.exports=b["default"]}).call(b,function(){return this}())},function(a,b){"use strict";b.__esModule=!0;var c={helpers:{helperExpression:function(a){return"SubExpression"===a.type||("MustacheStatement"===a.type||"BlockStatement"===a.type)&&!!(a.params&&a.params.length||a.hash)},scopedId:function(a){return/^\.|this\b/.test(a.original)},simpleId:function(a){return 1===a.parts.length&&!c.helpers.scopedId(a)&&!a.depth}}};b["default"]=c,a.exports=b["default"]},function(a,b,c){"use strict";function d(a,b){if("Program"===a.type)return a;h["default"].yy=n,n.locInfo=function(a){return new n.SourceLocation(b&&b.srcName,a)};var c=new j["default"](b);return c.accept(h["default"].parse(a))}var e=c(1)["default"],f=c(3)["default"];b.__esModule=!0,b.parse=d;var g=c(23),h=e(g),i=c(24),j=e(i),k=c(26),l=f(k),m=c(5);b.parser=h["default"];var n={};m.extend(n,l)},function(a,b){"use strict";var c=function(){function a(){this.yy={}}var b={trace:function(){},yy:{},symbols_:{error:2,root:3,program:4,EOF:5,program_repetition0:6,statement:7,mustache:8,block:9,rawBlock:10,partial:11,partialBlock:12,content:13,COMMENT:14,CONTENT:15,openRawBlock:16,rawBlock_repetition_plus0:17,END_RAW_BLOCK:18,OPEN_RAW_BLOCK:19,helperName:20,openRawBlock_repetition0:21,openRawBlock_option0:22,CLOSE_RAW_BLOCK:23,openBlock:24,block_option0:25,closeBlock:26,openInverse:27,block_option1:28,OPEN_BLOCK:29,openBlock_repetition0:30,openBlock_option0:31,openBlock_option1:32,CLOSE:33,OPEN_INVERSE:34,openInverse_repetition0:35,openInverse_option0:36,openInverse_option1:37,openInverseChain:38,OPEN_INVERSE_CHAIN:39,openInverseChain_repetition0:40,openInverseChain_option0:41,openInverseChain_option1:42,inverseAndProgram:43,INVERSE:44,inverseChain:45,inverseChain_option0:46,OPEN_ENDBLOCK:47,OPEN:48,mustache_repetition0:49,mustache_option0:50,OPEN_UNESCAPED:51,mustache_repetition1:52,mustache_option1:53,CLOSE_UNESCAPED:54,OPEN_PARTIAL:55,partialName:56,partial_repetition0:57,partial_option0:58,openPartialBlock:59,OPEN_PARTIAL_BLOCK:60,openPartialBlock_repetition0:61,openPartialBlock_option0:62,param:63,sexpr:64,OPEN_SEXPR:65,sexpr_repetition0:66,sexpr_option0:67,CLOSE_SEXPR:68,hash:69,hash_repetition_plus0:70,hashSegment:71,ID:72,EQUALS:73,blockParams:74,OPEN_BLOCK_PARAMS:75,blockParams_repetition_plus0:76,CLOSE_BLOCK_PARAMS:77,path:78,dataName:79,STRING:80,NUMBER:81,BOOLEAN:82,UNDEFINED:83,NULL:84,DATA:85,pathSegments:86,SEP:87,$accept:0,$end:1},terminals_:{2:"error",5:"EOF",14:"COMMENT",15:"CONTENT",18:"END_RAW_BLOCK",19:"OPEN_RAW_BLOCK",23:"CLOSE_RAW_BLOCK",29:"OPEN_BLOCK",33:"CLOSE",34:"OPEN_INVERSE",39:"OPEN_INVERSE_CHAIN",44:"INVERSE",47:"OPEN_ENDBLOCK",48:"OPEN",51:"OPEN_UNESCAPED",54:"CLOSE_UNESCAPED",55:"OPEN_PARTIAL",60:"OPEN_PARTIAL_BLOCK",65:"OPEN_SEXPR",68:"CLOSE_SEXPR",72:"ID",73:"EQUALS",75:"OPEN_BLOCK_PARAMS",77:"CLOSE_BLOCK_PARAMS",80:"STRING",81:"NUMBER",82:"BOOLEAN",83:"UNDEFINED",84:"NULL",85:"DATA",87:"SEP"},productions_:[0,[3,2],[4,1],[7,1],[7,1],[7,1],[7,1],[7,1],[7,1],[7,1],[13,1],[10,3],[16,5],[9,4],[9,4],[24,6],[27,6],[38,6],[43,2],[45,3],[45,1],[26,3],[8,5],[8,5],[11,5],[12,3],[59,5],[63,1],[63,1],[64,5],[69,1],[71,3],[74,3],[20,1],[20,1],[20,1],[20,1],[20,1],[20,1],[20,1],[56,1],[56,1],[79,2],[78,1],[86,3],[86,1],[6,0],[6,2],[17,1],[17,2],[21,0],[21,2],[22,0],[22,1],[25,0],[25,1],[28,0],[28,1],[30,0],[30,2],[31,0],[31,1],[32,0],[32,1],[35,0],[35,2],[36,0],[36,1],[37,0],[37,1],[40,0],[40,2],[41,0],[41,1],[42,0],[42,1],[46,0],[46,1],[49,0],[49,2],[50,0],[50,1],[52,0],[52,2],[53,0],[53,1],[57,0],[57,2],[58,0],[58,1],[61,0],[61,2],[62,0],[62,1],[66,0],[66,2],[67,0],[67,1],[70,1],[70,2],[76,1],[76,2]],performAction:function(a,b,c,d,e,f,g){var h=f.length-1;switch(e){case 1:return f[h-1];case 2:this.$=d.prepareProgram(f[h]);break;case 3:this.$=f[h];break;case 4:this.$=f[h];break;case 5:this.$=f[h];break;case 6:this.$=f[h];break;case 7:this.$=f[h];break;case 8:this.$=f[h];break;case 9:this.$={type:"CommentStatement",value:d.stripComment(f[h]),strip:d.stripFlags(f[h],f[h]),loc:d.locInfo(this._$)};break;case 10:this.$={type:"ContentStatement",original:f[h],value:f[h],loc:d.locInfo(this._$)};break;case 11:this.$=d.prepareRawBlock(f[h-2],f[h-1],f[h],this._$);break;case 12:this.$={path:f[h-3],params:f[h-2],hash:f[h-1]};break;case 13:this.$=d.prepareBlock(f[h-3],f[h-2],f[h-1],f[h],!1,this._$);break;case 14:this.$=d.prepareBlock(f[h-3],f[h-2],f[h-1],f[h],!0,this._$);break;case 15:this.$={open:f[h-5],path:f[h-4],params:f[h-3],hash:f[h-2],blockParams:f[h-1],strip:d.stripFlags(f[h-5],f[h])};break;case 16:this.$={path:f[h-4],params:f[h-3],hash:f[h-2],blockParams:f[h-1],strip:d.stripFlags(f[h-5],f[h])};break;case 17:this.$={path:f[h-4],params:f[h-3],hash:f[h-2],blockParams:f[h-1],strip:d.stripFlags(f[h-5],f[h])};break;case 18:this.$={strip:d.stripFlags(f[h-1],f[h-1]),program:f[h]};break;case 19:var i=d.prepareBlock(f[h-2],f[h-1],f[h],f[h],!1,this._$),j=d.prepareProgram([i],f[h-1].loc);j.chained=!0,this.$={strip:f[h-2].strip,program:j,chain:!0};break;case 20:this.$=f[h];break;case 21:this.$={path:f[h-1],strip:d.stripFlags(f[h-2],f[h])};break;case 22:this.$=d.prepareMustache(f[h-3],f[h-2],f[h-1],f[h-4],d.stripFlags(f[h-4],f[h]),this._$);break;case 23:this.$=d.prepareMustache(f[h-3],f[h-2],f[h-1],f[h-4],d.stripFlags(f[h-4],f[h]),this._$);break;case 24:this.$={type:"PartialStatement",name:f[h-3],params:f[h-2],hash:f[h-1],indent:"",strip:d.stripFlags(f[h-4],f[h]),loc:d.locInfo(this._$)};break;case 25:this.$=d.preparePartialBlock(f[h-2],f[h-1],f[h],this._$);break;case 26:this.$={path:f[h-3],params:f[h-2],hash:f[h-1],strip:d.stripFlags(f[h-4],f[h])};break;case 27:this.$=f[h];break;case 28:this.$=f[h];break;case 29:this.$={type:"SubExpression",path:f[h-3],params:f[h-2],hash:f[h-1],loc:d.locInfo(this._$)};break;case 30:this.$={type:"Hash",pairs:f[h],loc:d.locInfo(this._$)};break;case 31:this.$={type:"HashPair",key:d.id(f[h-2]),value:f[h],loc:d.locInfo(this._$)};break;case 32:this.$=d.id(f[h-1]);break;case 33:this.$=f[h];break;case 34:this.$=f[h];break;case 35:this.$={type:"StringLiteral",value:f[h],original:f[h],loc:d.locInfo(this._$)};break;case 36:this.$={type:"NumberLiteral",value:Number(f[h]),original:Number(f[h]),loc:d.locInfo(this._$)};break;case 37:this.$={type:"BooleanLiteral",value:"true"===f[h],original:"true"===f[h],loc:d.locInfo(this._$)};break;case 38:this.$={type:"UndefinedLiteral",original:void 0,value:void 0,loc:d.locInfo(this._$)};break;case 39:this.$={type:"NullLiteral",original:null,value:null,loc:d.locInfo(this._$)};break;case 40:this.$=f[h];break;case 41:this.$=f[h];break;case 42:this.$=d.preparePath(!0,f[h],this._$);break;case 43:this.$=d.preparePath(!1,f[h],this._$);break;case 44:f[h-2].push({part:d.id(f[h]),original:f[h],separator:f[h-1]}),this.$=f[h-2];break;case 45:this.$=[{part:d.id(f[h]),original:f[h]}];break;case 46:this.$=[];break;case 47:f[h-1].push(f[h]);break;case 48:this.$=[f[h]];break;case 49:f[h-1].push(f[h]);break;case 50:this.$=[];break;case 51:f[h-1].push(f[h]);break;case 58:this.$=[];break;case 59:f[h-1].push(f[h]);break;case 64:this.$=[];break;case 65:f[h-1].push(f[h]);break;case 70:this.$=[];break;case 71:f[h-1].push(f[h]);break;case 78:this.$=[];break;case 79:f[h-1].push(f[h]);break;case 82:this.$=[];break;case 83:f[h-1].push(f[h]);break;case 86:this.$=[];break;case 87:f[h-1].push(f[h]);break;case 90:this.$=[];break;case 91:f[h-1].push(f[h]);break;case 94:this.$=[];break;case 95:f[h-1].push(f[h]);break;case 98:this.$=[f[h]];break;case 99:f[h-1].push(f[h]);break;case 100:this.$=[f[h]];break;case 101:f[h-1].push(f[h])}},table:[{3:1,4:2,5:[2,46],6:3,14:[2,46],15:[2,46],19:[2,46],29:[2,46],34:[2,46],48:[2,46],51:[2,46],55:[2,46],60:[2,46]},{1:[3]},{5:[1,4]},{5:[2,2],7:5,8:6,9:7,10:8,11:9,12:10,13:11,14:[1,12],15:[1,20],16:17,19:[1,23],24:15,27:16,29:[1,21],34:[1,22],39:[2,2],44:[2,2],47:[2,2],48:[1,13],51:[1,14],55:[1,18],59:19,60:[1,24]},{1:[2,1]},{5:[2,47],14:[2,47],15:[2,47],19:[2,47],29:[2,47],34:[2,47],39:[2,47],44:[2,47],47:[2,47],48:[2,47],51:[2,47],55:[2,47],60:[2,47]},{5:[2,3],14:[2,3],15:[2,3],19:[2,3],29:[2,3],34:[2,3],39:[2,3],44:[2,3],47:[2,3],48:[2,3],51:[2,3],55:[2,3],60:[2,3]},{5:[2,4],14:[2,4],15:[2,4],19:[2,4],29:[2,4],34:[2,4],39:[2,4],44:[2,4],47:[2,4],48:[2,4],51:[2,4],55:[2,4],60:[2,4]},{5:[2,5],14:[2,5],15:[2,5],19:[2,5],29:[2,5],34:[2,5],39:[2,5],44:[2,5],47:[2,5],48:[2,5],51:[2,5],55:[2,5],60:[2,5]},{5:[2,6],14:[2,6],15:[2,6],19:[2,6],29:[2,6],34:[2,6],39:[2,6],44:[2,6],47:[2,6],48:[2,6],51:[2,6],55:[2,6],60:[2,6]},{5:[2,7],14:[2,7],15:[2,7],19:[2,7],29:[2,7],34:[2,7],39:[2,7],44:[2,7],47:[2,7],48:[2,7],51:[2,7],55:[2,7],60:[2,7]},{5:[2,8],14:[2,8],15:[2,8],19:[2,8],29:[2,8],34:[2,8],39:[2,8],44:[2,8],47:[2,8],48:[2,8],51:[2,8],55:[2,8],60:[2,8]},{5:[2,9],14:[2,9],15:[2,9],19:[2,9],29:[2,9],34:[2,9],39:[2,9],44:[2,9],47:[2,9],48:[2,9],51:[2,9],55:[2,9],60:[2,9]},{20:25,72:[1,35],78:26,79:27,80:[1,28],81:[1,29],82:[1,30],83:[1,31],84:[1,32],85:[1,34],86:33},{20:36,72:[1,35],78:26,79:27,80:[1,28],81:[1,29],82:[1,30],83:[1,31],84:[1,32],85:[1,34],86:33},{4:37,6:3,14:[2,46],15:[2,46],19:[2,46],29:[2,46],34:[2,46],39:[2,46],44:[2,46],47:[2,46],48:[2,46],51:[2,46],55:[2,46],60:[2,46]},{4:38,6:3,14:[2,46],15:[2,46],19:[2,46],29:[2,46],34:[2,46],44:[2,46],47:[2,46],48:[2,46],51:[2,46],55:[2,46],60:[2,46]},{13:40,15:[1,20],17:39},{20:42,56:41,64:43,65:[1,44],72:[1,35],78:26,79:27,80:[1,28],81:[1,29],82:[1,30],83:[1,31],84:[1,32],85:[1,34],86:33},{4:45,6:3,14:[2,46],15:[2,46],19:[2,46],29:[2,46],34:[2,46],47:[2,46],48:[2,46],51:[2,46],55:[2,46],60:[2,46]},{5:[2,10],14:[2,10],15:[2,10],18:[2,10],19:[2,10],29:[2,10],34:[2,10],39:[2,10],44:[2,10],47:[2,10],48:[2,10],51:[2,10],55:[2,10],60:[2,10]},{20:46,72:[1,35],78:26,79:27,80:[1,28],81:[1,29],82:[1,30],83:[1,31],84:[1,32],85:[1,34],86:33},{20:47,72:[1,35],78:26,79:27,80:[1,28],81:[1,29],82:[1,30],83:[1,31],84:[1,32],85:[1,34],86:33},{20:48,72:[1,35],78:26,79:27,80:[1,28],81:[1,29],82:[1,30],83:[1,31],84:[1,32],85:[1,34],86:33},{20:42,56:49,64:43,65:[1,44],72:[1,35],78:26,79:27,80:[1,28],81:[1,29],82:[1,30],83:[1,31],84:[1,32],85:[1,34],86:33},{33:[2,78],49:50,65:[2,78],72:[2,78],80:[2,78],81:[2,78],82:[2,78],83:[2,78],84:[2,78],85:[2,78]},{23:[2,33],33:[2,33],54:[2,33],65:[2,33],68:[2,33],72:[2,33],75:[2,33],80:[2,33],81:[2,33],82:[2,33],83:[2,33],84:[2,33],85:[2,33]},{23:[2,34],33:[2,34],54:[2,34],65:[2,34],68:[2,34],72:[2,34],75:[2,34],80:[2,34],81:[2,34],82:[2,34],83:[2,34],84:[2,34],85:[2,34]},{23:[2,35],33:[2,35],54:[2,35],65:[2,35],68:[2,35],72:[2,35],75:[2,35],80:[2,35],81:[2,35],82:[2,35],83:[2,35],84:[2,35],85:[2,35]},{23:[2,36],33:[2,36],54:[2,36],65:[2,36],68:[2,36],72:[2,36],75:[2,36],80:[2,36],81:[2,36],82:[2,36],83:[2,36],84:[2,36],85:[2,36]},{23:[2,37],33:[2,37],54:[2,37],65:[2,37],68:[2,37],72:[2,37],75:[2,37],80:[2,37],81:[2,37],82:[2,37],83:[2,37],84:[2,37],85:[2,37]},{23:[2,38],33:[2,38],54:[2,38],65:[2,38],68:[2,38],72:[2,38],75:[2,38],80:[2,38],81:[2,38],82:[2,38],83:[2,38],84:[2,38],85:[2,38]},{23:[2,39],33:[2,39],54:[2,39],65:[2,39],68:[2,39],72:[2,39],75:[2,39],80:[2,39],81:[2,39],82:[2,39],83:[2,39],84:[2,39],85:[2,39]},{23:[2,43],33:[2,43],54:[2,43],65:[2,43],68:[2,43],72:[2,43],75:[2,43],80:[2,43],81:[2,43],82:[2,43],83:[2,43],84:[2,43],85:[2,43],87:[1,51]},{72:[1,35],86:52},{23:[2,45],33:[2,45],54:[2,45],65:[2,45],68:[2,45],72:[2,45],75:[2,45],80:[2,45],81:[2,45],82:[2,45],83:[2,45],84:[2,45],85:[2,45],87:[2,45]},{52:53,54:[2,82],65:[2,82],72:[2,82],80:[2,82],81:[2,82],82:[2,82],83:[2,82],84:[2,82],85:[2,82]},{25:54,38:56,39:[1,58],43:57,44:[1,59],45:55,47:[2,54]},{28:60,43:61,44:[1,59],47:[2,56]},{13:63,15:[1,20],18:[1,62]},{15:[2,48],18:[2,48]},{33:[2,86],57:64,65:[2,86],72:[2,86],80:[2,86],81:[2,86],82:[2,86],83:[2,86],84:[2,86],85:[2,86]},{33:[2,40],65:[2,40],72:[2,40],80:[2,40],81:[2,40],82:[2,40],83:[2,40],84:[2,40],85:[2,40]},{33:[2,41],65:[2,41],72:[2,41],80:[2,41],81:[2,41],82:[2,41],83:[2,41],84:[2,41],85:[2,41]},{20:65,72:[1,35],78:26,79:27,80:[1,28],81:[1,29],82:[1,30],83:[1,31],84:[1,32],85:[1,34],86:33},{26:66,47:[1,67]},{30:68,33:[2,58],65:[2,58],72:[2,58],75:[2,58],80:[2,58],81:[2,58],82:[2,58],83:[2,58],84:[2,58],85:[2,58]},{33:[2,64],35:69,65:[2,64],72:[2,64],75:[2,64],80:[2,64],81:[2,64],82:[2,64],83:[2,64],84:[2,64],85:[2,64]},{21:70,23:[2,50],65:[2,50],72:[2,50],80:[2,50],81:[2,50],82:[2,50],83:[2,50],84:[2,50],85:[2,50]},{33:[2,90],61:71,65:[2,90],72:[2,90],80:[2,90],81:[2,90],82:[2,90],83:[2,90],84:[2,90],85:[2,90]},{20:75,33:[2,80],50:72,63:73,64:76,65:[1,44],69:74,70:77,71:78,72:[1,79],78:26,79:27,80:[1,28],81:[1,29],82:[1,30],83:[1,31],84:[1,32],85:[1,34],86:33},{72:[1,80]},{23:[2,42],33:[2,42],54:[2,42],65:[2,42],68:[2,42],72:[2,42],75:[2,42],80:[2,42],81:[2,42],82:[2,42],83:[2,42],84:[2,42],85:[2,42],87:[1,51]},{20:75,53:81,54:[2,84],63:82,64:76,65:[1,44],69:83,70:77,71:78,72:[1,79],78:26,79:27,80:[1,28],81:[1,29],82:[1,30],83:[1,31],84:[1,32],85:[1,34],86:33},{26:84,47:[1,67]},{47:[2,55]},{4:85,6:3,14:[2,46],15:[2,46],19:[2,46],29:[2,46],34:[2,46],39:[2,46],44:[2,46],47:[2,46],48:[2,46],51:[2,46],55:[2,46],60:[2,46]},{47:[2,20]},{20:86,72:[1,35],78:26,79:27,80:[1,28],81:[1,29],82:[1,30],83:[1,31],84:[1,32],85:[1,34],86:33},{4:87,6:3,14:[2,46],15:[2,46],19:[2,46],29:[2,46],34:[2,46],47:[2,46],48:[2,46],51:[2,46],55:[2,46],60:[2,46]},{26:88,47:[1,67]},{47:[2,57]},{5:[2,11],14:[2,11],15:[2,11],19:[2,11],29:[2,11],34:[2,11],39:[2,11],44:[2,11],47:[2,11],48:[2,11],51:[2,11],55:[2,11],60:[2,11]},{15:[2,49],18:[2,49]},{20:75,33:[2,88],58:89,63:90,64:76,65:[1,44],69:91,70:77,71:78,72:[1,79],78:26,79:27,80:[1,28],81:[1,29],82:[1,30],83:[1,31],84:[1,32],85:[1,34],86:33},{65:[2,94],66:92,68:[2,94],72:[2,94],80:[2,94],81:[2,94],82:[2,94],83:[2,94],84:[2,94],85:[2,94]},{5:[2,25],14:[2,25],15:[2,25],19:[2,25],29:[2,25],34:[2,25],39:[2,25],44:[2,25],47:[2,25],48:[2,25],51:[2,25],55:[2,25],60:[2,25]},{20:93,72:[1,35],78:26,79:27,80:[1,28],81:[1,29],82:[1,30],83:[1,31],84:[1,32],85:[1,34],86:33},{20:75,31:94,33:[2,60],63:95,64:76,65:[1,44],69:96,70:77,71:78,72:[1,79],75:[2,60],78:26,79:27,80:[1,28],81:[1,29],82:[1,30],83:[1,31],84:[1,32],85:[1,34],86:33},{20:75,33:[2,66],36:97,63:98,64:76,65:[1,44],69:99,70:77,71:78,72:[1,79],75:[2,66],78:26,79:27,80:[1,28],81:[1,29],82:[1,30],83:[1,31],84:[1,32],85:[1,34],86:33},{20:75,22:100,23:[2,52],63:101,64:76,65:[1,44],69:102,70:77,71:78,72:[1,79],78:26,79:27,80:[1,28],81:[1,29],82:[1,30],83:[1,31],84:[1,32],85:[1,34],86:33},{20:75,33:[2,92],62:103,63:104,64:76,65:[1,44],69:105,70:77,71:78,72:[1,79],78:26,79:27,80:[1,28],81:[1,29],82:[1,30],83:[1,31],84:[1,32],85:[1,34],86:33},{33:[1,106]},{33:[2,79],65:[2,79],72:[2,79],80:[2,79],81:[2,79],82:[2,79],83:[2,79],84:[2,79],85:[2,79]},{33:[2,81]},{23:[2,27],33:[2,27],54:[2,27],65:[2,27],68:[2,27],72:[2,27],75:[2,27],80:[2,27],81:[2,27],82:[2,27],83:[2,27],84:[2,27],85:[2,27]},{23:[2,28],33:[2,28],54:[2,28],65:[2,28],68:[2,28],72:[2,28],75:[2,28],80:[2,28],81:[2,28],82:[2,28],83:[2,28],84:[2,28],85:[2,28]},{23:[2,30],33:[2,30],54:[2,30],68:[2,30],71:107,72:[1,108],75:[2,30]},{23:[2,98],33:[2,98],54:[2,98],68:[2,98],72:[2,98],75:[2,98]},{23:[2,45],33:[2,45],54:[2,45],65:[2,45],68:[2,45],72:[2,45],73:[1,109],75:[2,45],80:[2,45],81:[2,45],82:[2,45],83:[2,45],84:[2,45],85:[2,45],87:[2,45]},{23:[2,44],33:[2,44],54:[2,44],65:[2,44],68:[2,44],72:[2,44],75:[2,44],80:[2,44],81:[2,44],82:[2,44],83:[2,44],84:[2,44],85:[2,44],87:[2,44]},{54:[1,110]},{54:[2,83],65:[2,83],72:[2,83],80:[2,83],81:[2,83],82:[2,83],83:[2,83],84:[2,83],85:[2,83]},{54:[2,85]},{5:[2,13],14:[2,13],15:[2,13],19:[2,13],29:[2,13],34:[2,13],39:[2,13],44:[2,13],47:[2,13],48:[2,13],51:[2,13],55:[2,13],60:[2,13]},{38:56,39:[1,58],43:57,44:[1,59],45:112,46:111,47:[2,76]},{33:[2,70],40:113,65:[2,70],72:[2,70],75:[2,70],80:[2,70],81:[2,70],82:[2,70],83:[2,70],84:[2,70],85:[2,70]},{47:[2,18]},{5:[2,14],14:[2,14],15:[2,14],19:[2,14],29:[2,14],34:[2,14],39:[2,14],44:[2,14],47:[2,14],48:[2,14],51:[2,14],55:[2,14],60:[2,14]},{33:[1,114]},{33:[2,87],65:[2,87],72:[2,87],80:[2,87],81:[2,87],82:[2,87],83:[2,87],84:[2,87],85:[2,87]},{33:[2,89]},{20:75,63:116,64:76,65:[1,44],67:115,68:[2,96],69:117,70:77,71:78,72:[1,79],78:26,79:27,80:[1,28],81:[1,29],82:[1,30],83:[1,31],84:[1,32],85:[1,34],86:33},{33:[1,118]},{32:119,33:[2,62],74:120,75:[1,121]},{33:[2,59],65:[2,59],72:[2,59],75:[2,59],80:[2,59],81:[2,59],82:[2,59],83:[2,59],84:[2,59],85:[2,59]},{33:[2,61],75:[2,61]},{33:[2,68],37:122,74:123,75:[1,121]},{33:[2,65],65:[2,65],72:[2,65],75:[2,65],80:[2,65],81:[2,65],82:[2,65],83:[2,65],84:[2,65],85:[2,65]},{33:[2,67],75:[2,67]},{23:[1,124]},{23:[2,51],65:[2,51],72:[2,51],80:[2,51],81:[2,51],82:[2,51],83:[2,51],84:[2,51],85:[2,51]},{23:[2,53]},{33:[1,125]},{33:[2,91],65:[2,91],72:[2,91],80:[2,91],81:[2,91],82:[2,91],83:[2,91],84:[2,91],85:[2,91]},{33:[2,93]},{5:[2,22],14:[2,22],15:[2,22],19:[2,22],29:[2,22],34:[2,22],39:[2,22],44:[2,22],47:[2,22],48:[2,22],51:[2,22],55:[2,22],60:[2,22]},{23:[2,99],33:[2,99],54:[2,99],68:[2,99],72:[2,99],75:[2,99]},{73:[1,109]},{20:75,63:126,64:76,65:[1,44],72:[1,35],78:26,79:27,80:[1,28],81:[1,29],82:[1,30],83:[1,31],84:[1,32],85:[1,34],86:33},{5:[2,23],14:[2,23],15:[2,23],19:[2,23],29:[2,23],34:[2,23],39:[2,23],44:[2,23],47:[2,23],48:[2,23],51:[2,23],55:[2,23],60:[2,23]},{47:[2,19]},{47:[2,77]},{20:75,33:[2,72],41:127,63:128,64:76,65:[1,44],69:129,70:77,71:78,72:[1,79],75:[2,72],78:26,79:27,80:[1,28],81:[1,29],82:[1,30],83:[1,31],84:[1,32],85:[1,34],86:33},{5:[2,24],14:[2,24],15:[2,24],19:[2,24],29:[2,24],34:[2,24],39:[2,24],44:[2,24],47:[2,24],48:[2,24],51:[2,24],55:[2,24],60:[2,24]},{68:[1,130]},{65:[2,95],68:[2,95],72:[2,95],80:[2,95],81:[2,95],82:[2,95],83:[2,95],84:[2,95],85:[2,95]},{68:[2,97]},{5:[2,21],14:[2,21],15:[2,21],19:[2,21],29:[2,21],34:[2,21],39:[2,21],44:[2,21],47:[2,21],48:[2,21],51:[2,21],55:[2,21],60:[2,21]},{33:[1,131]},{33:[2,63]},{72:[1,133],76:132},{33:[1,134]},{33:[2,69]},{15:[2,12]},{14:[2,26],15:[2,26],19:[2,26],29:[2,26],34:[2,26],47:[2,26],48:[2,26],51:[2,26],55:[2,26],60:[2,26]},{23:[2,31],33:[2,31],54:[2,31],68:[2,31],72:[2,31],75:[2,31]},{33:[2,74],42:135,74:136,75:[1,121]},{33:[2,71],65:[2,71],72:[2,71],75:[2,71],80:[2,71],81:[2,71],82:[2,71],83:[2,71],84:[2,71],85:[2,71]},{33:[2,73],75:[2,73]},{23:[2,29],33:[2,29],54:[2,29],65:[2,29],68:[2,29],72:[2,29],75:[2,29],80:[2,29],81:[2,29],82:[2,29],83:[2,29],84:[2,29],85:[2,29]},{14:[2,15],15:[2,15],19:[2,15],29:[2,15],34:[2,15],39:[2,15],44:[2,15],47:[2,15],48:[2,15],51:[2,15],55:[2,15],60:[2,15]},{72:[1,138],77:[1,137]},{72:[2,100],77:[2,100]},{14:[2,16],15:[2,16],19:[2,16],29:[2,16],34:[2,16],44:[2,16],47:[2,16], +48:[2,16],51:[2,16],55:[2,16],60:[2,16]},{33:[1,139]},{33:[2,75]},{33:[2,32]},{72:[2,101],77:[2,101]},{14:[2,17],15:[2,17],19:[2,17],29:[2,17],34:[2,17],39:[2,17],44:[2,17],47:[2,17],48:[2,17],51:[2,17],55:[2,17],60:[2,17]}],defaultActions:{4:[2,1],55:[2,55],57:[2,20],61:[2,57],74:[2,81],83:[2,85],87:[2,18],91:[2,89],102:[2,53],105:[2,93],111:[2,19],112:[2,77],117:[2,97],120:[2,63],123:[2,69],124:[2,12],136:[2,75],137:[2,32]},parseError:function(a,b){throw new Error(a)},parse:function(a){function b(){var a;return a=c.lexer.lex()||1,"number"!=typeof a&&(a=c.symbols_[a]||a),a}var c=this,d=[0],e=[null],f=[],g=this.table,h="",i=0,j=0,k=0;this.lexer.setInput(a),this.lexer.yy=this.yy,this.yy.lexer=this.lexer,this.yy.parser=this,"undefined"==typeof this.lexer.yylloc&&(this.lexer.yylloc={});var l=this.lexer.yylloc;f.push(l);var m=this.lexer.options&&this.lexer.options.ranges;"function"==typeof this.yy.parseError&&(this.parseError=this.yy.parseError);for(var n,o,p,q,r,s,t,u,v,w={};;){if(p=d[d.length-1],this.defaultActions[p]?q=this.defaultActions[p]:((null===n||"undefined"==typeof n)&&(n=b()),q=g[p]&&g[p][n]),"undefined"==typeof q||!q.length||!q[0]){var x="";if(!k){v=[];for(s in g[p])this.terminals_[s]&&s>2&&v.push("'"+this.terminals_[s]+"'");x=this.lexer.showPosition?"Parse error on line "+(i+1)+":\n"+this.lexer.showPosition()+"\nExpecting "+v.join(", ")+", got '"+(this.terminals_[n]||n)+"'":"Parse error on line "+(i+1)+": Unexpected "+(1==n?"end of input":"'"+(this.terminals_[n]||n)+"'"),this.parseError(x,{text:this.lexer.match,token:this.terminals_[n]||n,line:this.lexer.yylineno,loc:l,expected:v})}}if(q[0]instanceof Array&&q.length>1)throw new Error("Parse Error: multiple actions possible at state: "+p+", token: "+n);switch(q[0]){case 1:d.push(n),e.push(this.lexer.yytext),f.push(this.lexer.yylloc),d.push(q[1]),n=null,o?(n=o,o=null):(j=this.lexer.yyleng,h=this.lexer.yytext,i=this.lexer.yylineno,l=this.lexer.yylloc,k>0&&k--);break;case 2:if(t=this.productions_[q[1]][1],w.$=e[e.length-t],w._$={first_line:f[f.length-(t||1)].first_line,last_line:f[f.length-1].last_line,first_column:f[f.length-(t||1)].first_column,last_column:f[f.length-1].last_column},m&&(w._$.range=[f[f.length-(t||1)].range[0],f[f.length-1].range[1]]),r=this.performAction.call(w,h,j,i,this.yy,q[1],e,f),"undefined"!=typeof r)return r;t&&(d=d.slice(0,-1*t*2),e=e.slice(0,-1*t),f=f.slice(0,-1*t)),d.push(this.productions_[q[1]][0]),e.push(w.$),f.push(w._$),u=g[d[d.length-2]][d[d.length-1]],d.push(u);break;case 3:return!0}}return!0}},c=function(){var a={EOF:1,parseError:function(a,b){if(!this.yy.parser)throw new Error(a);this.yy.parser.parseError(a,b)},setInput:function(a){return this._input=a,this._more=this._less=this.done=!1,this.yylineno=this.yyleng=0,this.yytext=this.matched=this.match="",this.conditionStack=["INITIAL"],this.yylloc={first_line:1,first_column:0,last_line:1,last_column:0},this.options.ranges&&(this.yylloc.range=[0,0]),this.offset=0,this},input:function(){var a=this._input[0];this.yytext+=a,this.yyleng++,this.offset++,this.match+=a,this.matched+=a;var b=a.match(/(?:\r\n?|\n).*/g);return b?(this.yylineno++,this.yylloc.last_line++):this.yylloc.last_column++,this.options.ranges&&this.yylloc.range[1]++,this._input=this._input.slice(1),a},unput:function(a){var b=a.length,c=a.split(/(?:\r\n?|\n)/g);this._input=a+this._input,this.yytext=this.yytext.substr(0,this.yytext.length-b-1),this.offset-=b;var d=this.match.split(/(?:\r\n?|\n)/g);this.match=this.match.substr(0,this.match.length-1),this.matched=this.matched.substr(0,this.matched.length-1),c.length-1&&(this.yylineno-=c.length-1);var e=this.yylloc.range;return this.yylloc={first_line:this.yylloc.first_line,last_line:this.yylineno+1,first_column:this.yylloc.first_column,last_column:c?(c.length===d.length?this.yylloc.first_column:0)+d[d.length-c.length].length-c[0].length:this.yylloc.first_column-b},this.options.ranges&&(this.yylloc.range=[e[0],e[0]+this.yyleng-b]),this},more:function(){return this._more=!0,this},less:function(a){this.unput(this.match.slice(a))},pastInput:function(){var a=this.matched.substr(0,this.matched.length-this.match.length);return(a.length>20?"...":"")+a.substr(-20).replace(/\n/g,"")},upcomingInput:function(){var a=this.match;return a.length<20&&(a+=this._input.substr(0,20-a.length)),(a.substr(0,20)+(a.length>20?"...":"")).replace(/\n/g,"")},showPosition:function(){var a=this.pastInput(),b=new Array(a.length+1).join("-");return a+this.upcomingInput()+"\n"+b+"^"},next:function(){if(this.done)return this.EOF;this._input||(this.done=!0);var a,b,c,d,e;this._more||(this.yytext="",this.match="");for(var f=this._currentRules(),g=0;gb[0].length)||(b=c,d=g,this.options.flex));g++);return b?(e=b[0].match(/(?:\r\n?|\n).*/g),e&&(this.yylineno+=e.length),this.yylloc={first_line:this.yylloc.last_line,last_line:this.yylineno+1,first_column:this.yylloc.last_column,last_column:e?e[e.length-1].length-e[e.length-1].match(/\r?\n?/)[0].length:this.yylloc.last_column+b[0].length},this.yytext+=b[0],this.match+=b[0],this.matches=b,this.yyleng=this.yytext.length,this.options.ranges&&(this.yylloc.range=[this.offset,this.offset+=this.yyleng]),this._more=!1,this._input=this._input.slice(b[0].length),this.matched+=b[0],a=this.performAction.call(this,this.yy,this,f[d],this.conditionStack[this.conditionStack.length-1]),this.done&&this._input&&(this.done=!1),a?a:void 0):""===this._input?this.EOF:this.parseError("Lexical error on line "+(this.yylineno+1)+". Unrecognized text.\n"+this.showPosition(),{text:"",token:null,line:this.yylineno})},lex:function(){var a=this.next();return"undefined"!=typeof a?a:this.lex()},begin:function(a){this.conditionStack.push(a)},popState:function(){return this.conditionStack.pop()},_currentRules:function(){return this.conditions[this.conditionStack[this.conditionStack.length-1]].rules},topState:function(){return this.conditionStack[this.conditionStack.length-2]},pushState:function(a){this.begin(a)}};return a.options={},a.performAction=function(a,b,c,d){function e(a,c){return b.yytext=b.yytext.substr(a,b.yyleng-c)}switch(c){case 0:if("\\\\"===b.yytext.slice(-2)?(e(0,1),this.begin("mu")):"\\"===b.yytext.slice(-1)?(e(0,1),this.begin("emu")):this.begin("mu"),b.yytext)return 15;break;case 1:return 15;case 2:return this.popState(),15;case 3:return this.begin("raw"),15;case 4:return this.popState(),"raw"===this.conditionStack[this.conditionStack.length-1]?15:(b.yytext=b.yytext.substr(5,b.yyleng-9),"END_RAW_BLOCK");case 5:return 15;case 6:return this.popState(),14;case 7:return 65;case 8:return 68;case 9:return 19;case 10:return this.popState(),this.begin("raw"),23;case 11:return 55;case 12:return 60;case 13:return 29;case 14:return 47;case 15:return this.popState(),44;case 16:return this.popState(),44;case 17:return 34;case 18:return 39;case 19:return 51;case 20:return 48;case 21:this.unput(b.yytext),this.popState(),this.begin("com");break;case 22:return this.popState(),14;case 23:return 48;case 24:return 73;case 25:return 72;case 26:return 72;case 27:return 87;case 28:break;case 29:return this.popState(),54;case 30:return this.popState(),33;case 31:return b.yytext=e(1,2).replace(/\\"/g,'"'),80;case 32:return b.yytext=e(1,2).replace(/\\'/g,"'"),80;case 33:return 85;case 34:return 82;case 35:return 82;case 36:return 83;case 37:return 84;case 38:return 81;case 39:return 75;case 40:return 77;case 41:return 72;case 42:return b.yytext=b.yytext.replace(/\\([\\\]])/g,"$1"),72;case 43:return"INVALID";case 44:return 5}},a.rules=[/^(?:[^\x00]*?(?=(\{\{)))/,/^(?:[^\x00]+)/,/^(?:[^\x00]{2,}?(?=(\{\{|\\\{\{|\\\\\{\{|$)))/,/^(?:\{\{\{\{(?=[^\/]))/,/^(?:\{\{\{\{\/[^\s!"#%-,\.\/;->@\[-\^`\{-~]+(?=[=}\s\/.])\}\}\}\})/,/^(?:[^\x00]*?(?=(\{\{\{\{)))/,/^(?:[\s\S]*?--(~)?\}\})/,/^(?:\()/,/^(?:\))/,/^(?:\{\{\{\{)/,/^(?:\}\}\}\})/,/^(?:\{\{(~)?>)/,/^(?:\{\{(~)?#>)/,/^(?:\{\{(~)?#\*?)/,/^(?:\{\{(~)?\/)/,/^(?:\{\{(~)?\^\s*(~)?\}\})/,/^(?:\{\{(~)?\s*else\s*(~)?\}\})/,/^(?:\{\{(~)?\^)/,/^(?:\{\{(~)?\s*else\b)/,/^(?:\{\{(~)?\{)/,/^(?:\{\{(~)?&)/,/^(?:\{\{(~)?!--)/,/^(?:\{\{(~)?![\s\S]*?\}\})/,/^(?:\{\{(~)?\*?)/,/^(?:=)/,/^(?:\.\.)/,/^(?:\.(?=([=~}\s\/.)|])))/,/^(?:[\/.])/,/^(?:\s+)/,/^(?:\}(~)?\}\})/,/^(?:(~)?\}\})/,/^(?:"(\\["]|[^"])*")/,/^(?:'(\\[']|[^'])*')/,/^(?:@)/,/^(?:true(?=([~}\s)])))/,/^(?:false(?=([~}\s)])))/,/^(?:undefined(?=([~}\s)])))/,/^(?:null(?=([~}\s)])))/,/^(?:-?[0-9]+(?:\.[0-9]+)?(?=([~}\s)])))/,/^(?:as\s+\|)/,/^(?:\|)/,/^(?:([^\s!"#%-,\.\/;->@\[-\^`\{-~]+(?=([=~}\s\/.)|]))))/,/^(?:\[(\\\]|[^\]])*\])/,/^(?:.)/,/^(?:$)/],a.conditions={mu:{rules:[7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44],inclusive:!1},emu:{rules:[2],inclusive:!1},com:{rules:[6],inclusive:!1},raw:{rules:[3,4,5],inclusive:!1},INITIAL:{rules:[0,1,44],inclusive:!0}},a}();return b.lexer=c,a.prototype=b,b.Parser=a,new a}();b.__esModule=!0,b["default"]=c},function(a,b,c){"use strict";function d(){var a=arguments.length<=0||void 0===arguments[0]?{}:arguments[0];this.options=a}function e(a,b,c){void 0===b&&(b=a.length);var d=a[b-1],e=a[b-2];return d?"ContentStatement"===d.type?(e||!c?/\r?\n\s*?$/:/(^|\r?\n)\s*?$/).test(d.original):void 0:c}function f(a,b,c){void 0===b&&(b=-1);var d=a[b+1],e=a[b+2];return d?"ContentStatement"===d.type?(e||!c?/^\s*?\r?\n/:/^\s*?(\r?\n|$)/).test(d.original):void 0:c}function g(a,b,c){var d=a[null==b?0:b+1];if(d&&"ContentStatement"===d.type&&(c||!d.rightStripped)){var e=d.value;d.value=d.value.replace(c?/^\s+/:/^[ \t]*\r?\n?/,""),d.rightStripped=d.value!==e}}function h(a,b,c){var d=a[null==b?a.length-1:b-1];if(d&&"ContentStatement"===d.type&&(c||!d.leftStripped)){var e=d.value;return d.value=d.value.replace(c?/\s+$/:/[ \t]+$/,""),d.leftStripped=d.value!==e,d.leftStripped}}var i=c(1)["default"];b.__esModule=!0;var j=c(25),k=i(j);d.prototype=new k["default"],d.prototype.Program=function(a){var b=!this.options.ignoreStandalone,c=!this.isRootSeen;this.isRootSeen=!0;for(var d=a.body,i=0,j=d.length;j>i;i++){var k=d[i],l=this.accept(k);if(l){var m=e(d,i,c),n=f(d,i,c),o=l.openStandalone&&m,p=l.closeStandalone&&n,q=l.inlineStandalone&&m&&n;l.close&&g(d,i,!0),l.open&&h(d,i,!0),b&&q&&(g(d,i),h(d,i)&&"PartialStatement"===k.type&&(k.indent=/([ \t]+$)/.exec(d[i-1].original)[1])),b&&o&&(g((k.program||k.inverse).body),h(d,i)),b&&p&&(g(d,i),h((k.inverse||k.program).body))}}return a},d.prototype.BlockStatement=d.prototype.DecoratorBlock=d.prototype.PartialBlockStatement=function(a){this.accept(a.program),this.accept(a.inverse);var b=a.program||a.inverse,c=a.program&&a.inverse,d=c,i=c;if(c&&c.chained)for(d=c.body[0].program;i.chained;)i=i.body[i.body.length-1].program;var j={open:a.openStrip.open,close:a.closeStrip.close,openStandalone:f(b.body),closeStandalone:e((d||b).body)};if(a.openStrip.close&&g(b.body,null,!0),c){var k=a.inverseStrip;k.open&&h(b.body,null,!0),k.close&&g(d.body,null,!0),a.closeStrip.open&&h(i.body,null,!0),!this.options.ignoreStandalone&&e(b.body)&&f(d.body)&&(h(b.body),g(d.body))}else a.closeStrip.open&&h(b.body,null,!0);return j},d.prototype.Decorator=d.prototype.MustacheStatement=function(a){return a.strip},d.prototype.PartialStatement=d.prototype.CommentStatement=function(a){var b=a.strip||{};return{inlineStandalone:!0,open:b.open,close:b.close}},b["default"]=d,a.exports=b["default"]},function(a,b,c){"use strict";function d(){this.parents=[]}function e(a){this.acceptRequired(a,"path"),this.acceptArray(a.params),this.acceptKey(a,"hash")}function f(a){e.call(this,a),this.acceptKey(a,"program"),this.acceptKey(a,"inverse")}function g(a){this.acceptRequired(a,"name"),this.acceptArray(a.params),this.acceptKey(a,"hash")}var h=c(1)["default"];b.__esModule=!0;var i=c(6),j=h(i);d.prototype={constructor:d,mutating:!1,acceptKey:function(a,b){var c=this.accept(a[b]);if(this.mutating){if(c&&!d.prototype[c.type])throw new j["default"]('Unexpected node type "'+c.type+'" found when accepting '+b+" on "+a.type);a[b]=c}},acceptRequired:function(a,b){if(this.acceptKey(a,b),!a[b])throw new j["default"](a.type+" requires "+b)},acceptArray:function(a){for(var b=0,c=a.length;c>b;b++)this.acceptKey(a,b),a[b]||(a.splice(b,1),b--,c--)},accept:function(a){if(a){if(!this[a.type])throw new j["default"]("Unknown type: "+a.type,a);this.current&&this.parents.unshift(this.current),this.current=a;var b=this[a.type](a);return this.current=this.parents.shift(),!this.mutating||b?b:b!==!1?a:void 0}},Program:function(a){this.acceptArray(a.body)},MustacheStatement:e,Decorator:e,BlockStatement:f,DecoratorBlock:f,PartialStatement:g,PartialBlockStatement:function(a){g.call(this,a),this.acceptKey(a,"program")},ContentStatement:function(){},CommentStatement:function(){},SubExpression:e,PathExpression:function(){},StringLiteral:function(){},NumberLiteral:function(){},BooleanLiteral:function(){},UndefinedLiteral:function(){},NullLiteral:function(){},Hash:function(a){this.acceptArray(a.pairs)},HashPair:function(a){this.acceptRequired(a,"value")}},b["default"]=d,a.exports=b["default"]},function(a,b,c){"use strict";function d(a,b){if(b=b.path?b.path.original:b,a.path.original!==b){var c={loc:a.path.loc};throw new q["default"](a.path.original+" doesn't match "+b,c)}}function e(a,b){this.source=a,this.start={line:b.first_line,column:b.first_column},this.end={line:b.last_line,column:b.last_column}}function f(a){return/^\[.*\]$/.test(a)?a.substr(1,a.length-2):a}function g(a,b){return{open:"~"===a.charAt(2),close:"~"===b.charAt(b.length-3)}}function h(a){return a.replace(/^\{\{~?\!-?-?/,"").replace(/-?-?~?\}\}$/,"")}function i(a,b,c){c=this.locInfo(c);for(var d=a?"@":"",e=[],f=0,g="",h=0,i=b.length;i>h;h++){var j=b[h].part,k=b[h].original!==j;if(d+=(b[h].separator||"")+j,k||".."!==j&&"."!==j&&"this"!==j)e.push(j);else{if(e.length>0)throw new q["default"]("Invalid path: "+d,{loc:c});".."===j&&(f++,g+="../")}}return{type:"PathExpression",data:a,depth:f,parts:e,original:d,loc:c}}function j(a,b,c,d,e,f){var g=d.charAt(3)||d.charAt(2),h="{"!==g&&"&"!==g,i=/\*/.test(d);return{type:i?"Decorator":"MustacheStatement",path:a,params:b,hash:c,escaped:h,strip:e,loc:this.locInfo(f)}}function k(a,b,c,e){d(a,c),e=this.locInfo(e);var f={type:"Program",body:b,strip:{},loc:e};return{type:"BlockStatement",path:a.path,params:a.params,hash:a.hash,program:f,openStrip:{},inverseStrip:{},closeStrip:{},loc:e}}function l(a,b,c,e,f,g){e&&e.path&&d(a,e);var h=/\*/.test(a.open);b.blockParams=a.blockParams;var i=void 0,j=void 0;if(c){if(h)throw new q["default"]("Unexpected inverse block on decorator",c);c.chain&&(c.program.body[0].closeStrip=e.strip),j=c.strip,i=c.program}return f&&(f=i,i=b,b=f),{type:h?"DecoratorBlock":"BlockStatement",path:a.path,params:a.params,hash:a.hash,program:b,inverse:i,openStrip:a.strip,inverseStrip:j,closeStrip:e&&e.strip,loc:this.locInfo(g)}}function m(a,b){if(!b&&a.length){var c=a[0].loc,d=a[a.length-1].loc;c&&d&&(b={source:c.source,start:{line:c.start.line,column:c.start.column},end:{line:d.end.line,column:d.end.column}})}return{type:"Program",body:a,strip:{},loc:b}}function n(a,b,c,e){return d(a,c),{type:"PartialBlockStatement",name:a.path,params:a.params,hash:a.hash,program:b,openStrip:a.strip,closeStrip:c&&c.strip,loc:this.locInfo(e)}}var o=c(1)["default"];b.__esModule=!0,b.SourceLocation=e,b.id=f,b.stripFlags=g,b.stripComment=h,b.preparePath=i,b.prepareMustache=j,b.prepareRawBlock=k,b.prepareBlock=l,b.prepareProgram=m,b.preparePartialBlock=n;var p=c(6),q=o(p)},function(a,b,c){"use strict";function d(){}function e(a,b,c){if(null==a||"string"!=typeof a&&"Program"!==a.type)throw new k["default"]("You must pass a string or Handlebars AST to Handlebars.precompile. You passed "+a);b=b||{},"data"in b||(b.data=!0),b.compat&&(b.useDepths=!0);var d=c.parse(a,b),e=(new c.Compiler).compile(d,b);return(new c.JavaScriptCompiler).compile(e,b)}function f(a,b,c){function d(){var d=c.parse(a,b),e=(new c.Compiler).compile(d,b),f=(new c.JavaScriptCompiler).compile(e,b,void 0,!0);return c.template(f)}function e(a,b){return f||(f=d()),f.call(this,a,b)}if(void 0===b&&(b={}),null==a||"string"!=typeof a&&"Program"!==a.type)throw new k["default"]("You must pass a string or Handlebars AST to Handlebars.compile. You passed "+a);"data"in b||(b.data=!0),b.compat&&(b.useDepths=!0);var f=void 0;return e._setup=function(a){return f||(f=d()),f._setup(a)},e._child=function(a,b,c,e){return f||(f=d()),f._child(a,b,c,e)},e}function g(a,b){if(a===b)return!0;if(l.isArray(a)&&l.isArray(b)&&a.length===b.length){for(var c=0;cc;c++){var d=this.opcodes[c],e=a.opcodes[c];if(d.opcode!==e.opcode||!g(d.args,e.args))return!1}b=this.children.length;for(var c=0;b>c;c++)if(!this.children[c].equals(a.children[c]))return!1;return!0},guid:0,compile:function(a,b){this.sourceNode=[],this.opcodes=[],this.children=[],this.options=b,this.stringParams=b.stringParams,this.trackIds=b.trackIds,b.blockParams=b.blockParams||[];var c=b.knownHelpers;if(b.knownHelpers={helperMissing:!0,blockHelperMissing:!0,each:!0,"if":!0,unless:!0,"with":!0,log:!0,lookup:!0},c)for(var d in c)d in c&&(b.knownHelpers[d]=c[d]);return this.accept(a)},compileProgram:function(a){var b=new this.compiler,c=b.compile(a,this.options),d=this.guid++;return this.usePartial=this.usePartial||c.usePartial,this.children[d]=c,this.useDepths=this.useDepths||c.useDepths,d},accept:function(a){if(!this[a.type])throw new k["default"]("Unknown type: "+a.type,a);this.sourceNode.unshift(a);var b=this[a.type](a);return this.sourceNode.shift(),b},Program:function(a){this.options.blockParams.unshift(a.blockParams);for(var b=a.body,c=b.length,d=0;c>d;d++)this.accept(b[d]);return this.options.blockParams.shift(),this.isSimple=1===c,this.blockParams=a.blockParams?a.blockParams.length:0,this},BlockStatement:function(a){h(a);var b=a.program,c=a.inverse;b=b&&this.compileProgram(b),c=c&&this.compileProgram(c);var d=this.classifySexpr(a);"helper"===d?this.helperSexpr(a,b,c):"simple"===d?(this.simpleSexpr(a),this.opcode("pushProgram",b),this.opcode("pushProgram",c),this.opcode("emptyHash"),this.opcode("blockValue",a.path.original)):(this.ambiguousSexpr(a,b,c),this.opcode("pushProgram",b),this.opcode("pushProgram",c),this.opcode("emptyHash"),this.opcode("ambiguousBlockValue")),this.opcode("append")},DecoratorBlock:function(a){var b=a.program&&this.compileProgram(a.program),c=this.setupFullMustacheParams(a,b,void 0),d=a.path;this.useDecorators=!0,this.opcode("registerDecorator",c.length,d.original)},PartialStatement:function(a){this.usePartial=!0;var b=a.program;b&&(b=this.compileProgram(a.program));var c=a.params;if(c.length>1)throw new k["default"]("Unsupported number of partial arguments: "+c.length,a);c.length||(this.options.explicitPartialContext?this.opcode("pushLiteral","undefined"):c.push({type:"PathExpression",parts:[],depth:0}));var d=a.name.original,e="SubExpression"===a.name.type;e&&this.accept(a.name),this.setupFullMustacheParams(a,b,void 0,!0);var f=a.indent||"";this.options.preventIndent&&f&&(this.opcode("appendContent",f),f=""),this.opcode("invokePartial",e,d,f),this.opcode("append")},PartialBlockStatement:function(a){this.PartialStatement(a)},MustacheStatement:function(a){this.SubExpression(a),a.escaped&&!this.options.noEscape?this.opcode("appendEscaped"):this.opcode("append")},Decorator:function(a){this.DecoratorBlock(a)},ContentStatement:function(a){a.value&&this.opcode("appendContent",a.value)},CommentStatement:function(){},SubExpression:function(a){h(a);var b=this.classifySexpr(a);"simple"===b?this.simpleSexpr(a):"helper"===b?this.helperSexpr(a):this.ambiguousSexpr(a)},ambiguousSexpr:function(a,b,c){var d=a.path,e=d.parts[0],f=null!=b||null!=c;this.opcode("getContext",d.depth),this.opcode("pushProgram",b),this.opcode("pushProgram",c),d.strict=!0,this.accept(d),this.opcode("invokeAmbiguous",e,f)},simpleSexpr:function(a){var b=a.path;b.strict=!0,this.accept(b),this.opcode("resolvePossibleLambda")},helperSexpr:function(a,b,c){var d=this.setupFullMustacheParams(a,b,c),e=a.path,f=e.parts[0];if(this.options.knownHelpers[f])this.opcode("invokeKnownHelper",d.length,f);else{if(this.options.knownHelpersOnly)throw new k["default"]("You specified knownHelpersOnly, but used the unknown helper "+f,a);e.strict=!0,e.falsy=!0,this.accept(e),this.opcode("invokeHelper",d.length,e.original,n["default"].helpers.simpleId(e))}},PathExpression:function(a){this.addDepth(a.depth),this.opcode("getContext",a.depth);var b=a.parts[0],c=n["default"].helpers.scopedId(a),d=!a.depth&&!c&&this.blockParamIndex(b);d?this.opcode("lookupBlockParam",d,a.parts):b?a.data?(this.options.data=!0,this.opcode("lookupData",a.depth,a.parts,a.strict)):this.opcode("lookupOnContext",a.parts,a.falsy,a.strict,c):this.opcode("pushContext")},StringLiteral:function(a){this.opcode("pushString",a.value)},NumberLiteral:function(a){this.opcode("pushLiteral",a.value)},BooleanLiteral:function(a){this.opcode("pushLiteral",a.value)},UndefinedLiteral:function(){this.opcode("pushLiteral","undefined")},NullLiteral:function(){this.opcode("pushLiteral","null")},Hash:function(a){var b=a.pairs,c=0,d=b.length;for(this.opcode("pushHash");d>c;c++)this.pushParam(b[c].value);for(;c--;)this.opcode("assignToHash",b[c].key);this.opcode("popHash")},opcode:function(a){this.opcodes.push({opcode:a,args:o.call(arguments,1),loc:this.sourceNode[0].loc})},addDepth:function(a){a&&(this.useDepths=!0)},classifySexpr:function(a){var b=n["default"].helpers.simpleId(a.path),c=b&&!!this.blockParamIndex(a.path.parts[0]),d=!c&&n["default"].helpers.helperExpression(a),e=!c&&(d||b);if(e&&!d){var f=a.path.parts[0],g=this.options;g.knownHelpers[f]?d=!0:g.knownHelpersOnly&&(e=!1)}return d?"helper":e?"ambiguous":"simple"},pushParams:function(a){for(var b=0,c=a.length;c>b;b++)this.pushParam(a[b])},pushParam:function(a){var b=null!=a.value?a.value:a.original||"";if(this.stringParams)b.replace&&(b=b.replace(/^(\.?\.\/)*/g,"").replace(/\//g,".")),a.depth&&this.addDepth(a.depth),this.opcode("getContext",a.depth||0),this.opcode("pushStringParam",b,a.type),"SubExpression"===a.type&&this.accept(a);else{if(this.trackIds){var c=void 0;if(!a.parts||n["default"].helpers.scopedId(a)||a.depth||(c=this.blockParamIndex(a.parts[0])),c){var d=a.parts.slice(1).join(".");this.opcode("pushId","BlockParam",c,d)}else b=a.original||b,b.replace&&(b=b.replace(/^this(?:\.|$)/,"").replace(/^\.\//,"").replace(/^\.$/,"")),this.opcode("pushId",a.type,b)}this.accept(a)}},setupFullMustacheParams:function(a,b,c,d){var e=a.params;return this.pushParams(e),this.opcode("pushProgram",b),this.opcode("pushProgram",c),a.hash?this.accept(a.hash):this.opcode("emptyHash",d),e},blockParamIndex:function(a){for(var b=0,c=this.options.blockParams.length;c>b;b++){var d=this.options.blockParams[b],e=d&&l.indexOf(d,a);if(d&&e>=0)return[b,e]}}}},function(a,b,c){"use strict";function d(a){this.value=a}function e(){}function f(a,b,c,d){var e=b.popStack(),f=0,g=c.length;for(a&&g--;g>f;f++)e=b.nameLookup(e,c[f],d);return a?[b.aliasable("container.strict"),"(",e,", ",b.quotedString(c[f]),")"]:e}var g=c(1)["default"];b.__esModule=!0;var h=c(4),i=c(6),j=g(i),k=c(5),l=c(29),m=g(l);e.prototype={nameLookup:function(a,b){return e.isValidJavaScriptVariableName(b)?[a,".",b]:[a,"[",JSON.stringify(b),"]"]},depthedLookup:function(a){return[this.aliasable("container.lookup"),'(depths, "',a,'")']},compilerInfo:function(){var a=h.COMPILER_REVISION,b=h.REVISION_CHANGES[a];return[a,b]},appendToBuffer:function(a,b,c){return k.isArray(a)||(a=[a]),a=this.source.wrap(a,b),this.environment.isSimple?["return ",a,";"]:c?["buffer += ",a,";"]:(a.appendToBuffer=!0,a)},initializeBuffer:function(){return this.quotedString("")},compile:function(a,b,c,d){this.environment=a,this.options=b,this.stringParams=this.options.stringParams,this.trackIds=this.options.trackIds,this.precompile=!d,this.name=this.environment.name,this.isChild=!!c,this.context=c||{decorators:[],programs:[],environments:[]},this.preamble(),this.stackSlot=0,this.stackVars=[],this.aliases={},this.registers={list:[]},this.hashes=[],this.compileStack=[],this.inlineStack=[],this.blockParams=[],this.compileChildren(a,b),this.useDepths=this.useDepths||a.useDepths||a.useDecorators||this.options.compat,this.useBlockParams=this.useBlockParams||a.useBlockParams;var e=a.opcodes,f=void 0,g=void 0,h=void 0,i=void 0;for(h=0,i=e.length;i>h;h++)f=e[h],this.source.currentLocation=f.loc,g=g||f.loc,this[f.opcode].apply(this,f.args);if(this.source.currentLocation=g,this.pushSource(""),this.stackSlot||this.inlineStack.length||this.compileStack.length)throw new j["default"]("Compile completed with content left on stack");this.decorators.isEmpty()?this.decorators=void 0:(this.useDecorators=!0,this.decorators.prepend("var decorators = container.decorators;\n"),this.decorators.push("return fn;"),d?this.decorators=Function.apply(this,["fn","props","container","depth0","data","blockParams","depths",this.decorators.merge()]):(this.decorators.prepend("function(fn, props, container, depth0, data, blockParams, depths) {\n"),this.decorators.push("}\n"),this.decorators=this.decorators.merge()));var k=this.createFunctionContext(d);if(this.isChild)return k;var l={compiler:this.compilerInfo(),main:k};this.decorators&&(l.main_d=this.decorators,l.useDecorators=!0);var m=this.context,n=m.programs,o=m.decorators;for(h=0,i=n.length;i>h;h++)n[h]&&(l[h]=n[h],o[h]&&(l[h+"_d"]=o[h],l.useDecorators=!0));return this.environment.usePartial&&(l.usePartial=!0),this.options.data&&(l.useData=!0),this.useDepths&&(l.useDepths=!0),this.useBlockParams&&(l.useBlockParams=!0),this.options.compat&&(l.compat=!0),d?l.compilerOptions=this.options:(l.compiler=JSON.stringify(l.compiler),this.source.currentLocation={start:{line:1,column:0}},l=this.objectLiteral(l),b.srcName?(l=l.toStringWithSourceMap({file:b.destName}),l.map=l.map&&l.map.toString()):l=l.toString()),l},preamble:function(){this.lastContext=0,this.source=new m["default"](this.options.srcName),this.decorators=new m["default"](this.options.srcName)},createFunctionContext:function(a){var b="",c=this.stackVars.concat(this.registers.list);c.length>0&&(b+=", "+c.join(", "));var d=0;for(var e in this.aliases){var f=this.aliases[e];this.aliases.hasOwnProperty(e)&&f.children&&f.referenceCount>1&&(b+=", alias"+ ++d+"="+e,f.children[0]="alias"+d)}var g=["container","depth0","helpers","partials","data"];(this.useBlockParams||this.useDepths)&&g.push("blockParams"),this.useDepths&&g.push("depths");var h=this.mergeSource(b);return a?(g.push(h),Function.apply(this,g)):this.source.wrap(["function(",g.join(","),") {\n ",h,"}"])},mergeSource:function(a){var b=this.environment.isSimple,c=!this.forceBuffer,d=void 0,e=void 0,f=void 0,g=void 0;return this.source.each(function(a){a.appendToBuffer?(f?a.prepend(" + "):f=a,g=a):(f&&(e?f.prepend("buffer += "):d=!0,g.add(";"),f=g=void 0),e=!0,b||(c=!1))}),c?f?(f.prepend("return "),g.add(";")):e||this.source.push('return "";'):(a+=", buffer = "+(d?"":this.initializeBuffer()),f?(f.prepend("return buffer + "),g.add(";")):this.source.push("return buffer;")),a&&this.source.prepend("var "+a.substring(2)+(d?"":";\n")),this.source.merge()},blockValue:function(a){var b=this.aliasable("helpers.blockHelperMissing"),c=[this.contextName(0)];this.setupHelperArgs(a,0,c);var d=this.popStack();c.splice(1,0,d),this.push(this.source.functionCall(b,"call",c))},ambiguousBlockValue:function(){var a=this.aliasable("helpers.blockHelperMissing"),b=[this.contextName(0)];this.setupHelperArgs("",0,b,!0),this.flushInline();var c=this.topStack();b.splice(1,0,c),this.pushSource(["if (!",this.lastHelper,") { ",c," = ",this.source.functionCall(a,"call",b),"}"])},appendContent:function(a){this.pendingContent?a=this.pendingContent+a:this.pendingLocation=this.source.currentLocation,this.pendingContent=a},append:function(){if(this.isInline())this.replaceStack(function(a){return[" != null ? ",a,' : ""']}),this.pushSource(this.appendToBuffer(this.popStack()));else{var a=this.popStack();this.pushSource(["if (",a," != null) { ",this.appendToBuffer(a,void 0,!0)," }"]),this.environment.isSimple&&this.pushSource(["else { ",this.appendToBuffer("''",void 0,!0)," }"])}},appendEscaped:function(){this.pushSource(this.appendToBuffer([this.aliasable("container.escapeExpression"),"(",this.popStack(),")"]))},getContext:function(a){this.lastContext=a},pushContext:function(){this.pushStackLiteral(this.contextName(this.lastContext))},lookupOnContext:function(a,b,c,d){var e=0;d||!this.options.compat||this.lastContext?this.pushContext():this.push(this.depthedLookup(a[e++])),this.resolvePath("context",a,e,b,c)},lookupBlockParam:function(a,b){this.useBlockParams=!0,this.push(["blockParams[",a[0],"][",a[1],"]"]),this.resolvePath("context",b,1)},lookupData:function(a,b,c){a?this.pushStackLiteral("container.data(data, "+a+")"):this.pushStackLiteral("data"),this.resolvePath("data",b,0,!0,c)},resolvePath:function(a,b,c,d,e){var g=this;if(this.options.strict||this.options.assumeObjects)return void this.push(f(this.options.strict&&e,this,b,a));for(var h=b.length;h>c;c++)this.replaceStack(function(e){var f=g.nameLookup(e,b[c],a);return d?[" && ",f]:[" != null ? ",f," : ",e]})},resolvePossibleLambda:function(){this.push([this.aliasable("container.lambda"),"(",this.popStack(),", ",this.contextName(0),")"])},pushStringParam:function(a,b){this.pushContext(),this.pushString(b),"SubExpression"!==b&&("string"==typeof a?this.pushString(a):this.pushStackLiteral(a))},emptyHash:function(a){this.trackIds&&this.push("{}"),this.stringParams&&(this.push("{}"),this.push("{}")),this.pushStackLiteral(a?"undefined":"{}")},pushHash:function(){this.hash&&this.hashes.push(this.hash),this.hash={values:[],types:[],contexts:[],ids:[]}},popHash:function(){var a=this.hash;this.hash=this.hashes.pop(),this.trackIds&&this.push(this.objectLiteral(a.ids)),this.stringParams&&(this.push(this.objectLiteral(a.contexts)),this.push(this.objectLiteral(a.types))),this.push(this.objectLiteral(a.values))},pushString:function(a){this.pushStackLiteral(this.quotedString(a))},pushLiteral:function(a){this.pushStackLiteral(a)},pushProgram:function(a){null!=a?this.pushStackLiteral(this.programExpression(a)):this.pushStackLiteral(null)},registerDecorator:function(a,b){var c=this.nameLookup("decorators",b,"decorator"),d=this.setupHelperArgs(b,a);this.decorators.push(["fn = ",this.decorators.functionCall(c,"",["fn","props","container",d])," || fn;"])},invokeHelper:function(a,b,c){var d=this.popStack(),e=this.setupHelper(a,b),f=c?[e.name," || "]:"",g=["("].concat(f,d);this.options.strict||g.push(" || ",this.aliasable("helpers.helperMissing")),g.push(")"),this.push(this.source.functionCall(g,"call",e.callParams))},invokeKnownHelper:function(a,b){var c=this.setupHelper(a,b);this.push(this.source.functionCall(c.name,"call",c.callParams))},invokeAmbiguous:function(a,b){this.useRegister("helper");var c=this.popStack();this.emptyHash();var d=this.setupHelper(0,a,b),e=this.lastHelper=this.nameLookup("helpers",a,"helper"),f=["(","(helper = ",e," || ",c,")"];this.options.strict||(f[0]="(helper = ",f.push(" != null ? helper : ",this.aliasable("helpers.helperMissing"))),this.push(["(",f,d.paramsInit?["),(",d.paramsInit]:[],"),","(typeof helper === ",this.aliasable('"function"')," ? ",this.source.functionCall("helper","call",d.callParams)," : helper))"])},invokePartial:function(a,b,c){var d=[],e=this.setupParams(b,1,d);a&&(b=this.popStack(),delete e.name),c&&(e.indent=JSON.stringify(c)),e.helpers="helpers",e.partials="partials",e.decorators="container.decorators",a?d.unshift(b):d.unshift(this.nameLookup("partials",b,"partial")),this.options.compat&&(e.depths="depths"),e=this.objectLiteral(e), +d.push(e),this.push(this.source.functionCall("container.invokePartial","",d))},assignToHash:function(a){var b=this.popStack(),c=void 0,d=void 0,e=void 0;this.trackIds&&(e=this.popStack()),this.stringParams&&(d=this.popStack(),c=this.popStack());var f=this.hash;c&&(f.contexts[a]=c),d&&(f.types[a]=d),e&&(f.ids[a]=e),f.values[a]=b},pushId:function(a,b,c){"BlockParam"===a?this.pushStackLiteral("blockParams["+b[0]+"].path["+b[1]+"]"+(c?" + "+JSON.stringify("."+c):"")):"PathExpression"===a?this.pushString(b):"SubExpression"===a?this.pushStackLiteral("true"):this.pushStackLiteral("null")},compiler:e,compileChildren:function(a,b){for(var c=a.children,d=void 0,e=void 0,f=0,g=c.length;g>f;f++){d=c[f],e=new this.compiler;var h=this.matchExistingProgram(d);null==h?(this.context.programs.push(""),h=this.context.programs.length,d.index=h,d.name="program"+h,this.context.programs[h]=e.compile(d,b,this.context,!this.precompile),this.context.decorators[h]=e.decorators,this.context.environments[h]=d,this.useDepths=this.useDepths||e.useDepths,this.useBlockParams=this.useBlockParams||e.useBlockParams):(d.index=h,d.name="program"+h,this.useDepths=this.useDepths||d.useDepths,this.useBlockParams=this.useBlockParams||d.useBlockParams)}},matchExistingProgram:function(a){for(var b=0,c=this.context.environments.length;c>b;b++){var d=this.context.environments[b];if(d&&d.equals(a))return b}},programExpression:function(a){var b=this.environment.children[a],c=[b.index,"data",b.blockParams];return(this.useBlockParams||this.useDepths)&&c.push("blockParams"),this.useDepths&&c.push("depths"),"container.program("+c.join(", ")+")"},useRegister:function(a){this.registers[a]||(this.registers[a]=!0,this.registers.list.push(a))},push:function(a){return a instanceof d||(a=this.source.wrap(a)),this.inlineStack.push(a),a},pushStackLiteral:function(a){this.push(new d(a))},pushSource:function(a){this.pendingContent&&(this.source.push(this.appendToBuffer(this.source.quotedString(this.pendingContent),this.pendingLocation)),this.pendingContent=void 0),a&&this.source.push(a)},replaceStack:function(a){var b=["("],c=void 0,e=void 0,f=void 0;if(!this.isInline())throw new j["default"]("replaceStack on non-inline");var g=this.popStack(!0);if(g instanceof d)c=[g.value],b=["(",c],f=!0;else{e=!0;var h=this.incrStack();b=["((",this.push(h)," = ",g,")"],c=this.topStack()}var i=a.call(this,c);f||this.popStack(),e&&this.stackSlot--,this.push(b.concat(i,")"))},incrStack:function(){return this.stackSlot++,this.stackSlot>this.stackVars.length&&this.stackVars.push("stack"+this.stackSlot),this.topStackName()},topStackName:function(){return"stack"+this.stackSlot},flushInline:function(){var a=this.inlineStack;this.inlineStack=[];for(var b=0,c=a.length;c>b;b++){var e=a[b];if(e instanceof d)this.compileStack.push(e);else{var f=this.incrStack();this.pushSource([f," = ",e,";"]),this.compileStack.push(f)}}},isInline:function(){return this.inlineStack.length},popStack:function(a){var b=this.isInline(),c=(b?this.inlineStack:this.compileStack).pop();if(!a&&c instanceof d)return c.value;if(!b){if(!this.stackSlot)throw new j["default"]("Invalid stack pop");this.stackSlot--}return c},topStack:function(){var a=this.isInline()?this.inlineStack:this.compileStack,b=a[a.length-1];return b instanceof d?b.value:b},contextName:function(a){return this.useDepths&&a?"depths["+a+"]":"depth"+a},quotedString:function(a){return this.source.quotedString(a)},objectLiteral:function(a){return this.source.objectLiteral(a)},aliasable:function(a){var b=this.aliases[a];return b?(b.referenceCount++,b):(b=this.aliases[a]=this.source.wrap(a),b.aliasable=!0,b.referenceCount=1,b)},setupHelper:function(a,b,c){var d=[],e=this.setupHelperArgs(b,a,d,c),f=this.nameLookup("helpers",b,"helper"),g=this.aliasable(this.contextName(0)+" != null ? "+this.contextName(0)+" : {}");return{params:d,paramsInit:e,name:f,callParams:[g].concat(d)}},setupParams:function(a,b,c){var d={},e=[],f=[],g=[],h=!c,i=void 0;h&&(c=[]),d.name=this.quotedString(a),d.hash=this.popStack(),this.trackIds&&(d.hashIds=this.popStack()),this.stringParams&&(d.hashTypes=this.popStack(),d.hashContexts=this.popStack());var j=this.popStack(),k=this.popStack();(k||j)&&(d.fn=k||"container.noop",d.inverse=j||"container.noop");for(var l=b;l--;)i=this.popStack(),c[l]=i,this.trackIds&&(g[l]=this.popStack()),this.stringParams&&(f[l]=this.popStack(),e[l]=this.popStack());return h&&(d.args=this.source.generateArray(c)),this.trackIds&&(d.ids=this.source.generateArray(g)),this.stringParams&&(d.types=this.source.generateArray(f),d.contexts=this.source.generateArray(e)),this.options.data&&(d.data="data"),this.useBlockParams&&(d.blockParams="blockParams"),d},setupHelperArgs:function(a,b,c,d){var e=this.setupParams(a,b,c);return e=this.objectLiteral(e),d?(this.useRegister("options"),c.push("options"),["options=",e]):c?(c.push(e),""):e}},function(){for(var a="break else new var case finally return void catch for switch while continue function this with default if throw delete in try do instanceof typeof abstract enum int short boolean export interface static byte extends long super char final native synchronized class float package throws const goto private transient debugger implements protected volatile double import public let yield await null true false".split(" "),b=e.RESERVED_WORDS={},c=0,d=a.length;d>c;c++)b[a[c]]=!0}(),e.isValidJavaScriptVariableName=function(a){return!e.RESERVED_WORDS[a]&&/^[a-zA-Z_$][0-9a-zA-Z_$]*$/.test(a)},b["default"]=e,a.exports=b["default"]},function(a,b,c){"use strict";function d(a,b,c){if(f.isArray(a)){for(var d=[],e=0,g=a.length;g>e;e++)d.push(b.wrap(a[e],c));return d}return"boolean"==typeof a||"number"==typeof a?a+"":a}function e(a){this.srcFile=a,this.source=[]}b.__esModule=!0;var f=c(5),g=void 0;try{}catch(h){}g||(g=function(a,b,c,d){this.src="",d&&this.add(d)},g.prototype={add:function(a){f.isArray(a)&&(a=a.join("")),this.src+=a},prepend:function(a){f.isArray(a)&&(a=a.join("")),this.src=a+this.src},toStringWithSourceMap:function(){return{code:this.toString()}},toString:function(){return this.src}}),e.prototype={isEmpty:function(){return!this.source.length},prepend:function(a,b){this.source.unshift(this.wrap(a,b))},push:function(a,b){this.source.push(this.wrap(a,b))},merge:function(){var a=this.empty();return this.each(function(b){a.add([" ",b,"\n"])}),a},each:function(a){for(var b=0,c=this.source.length;c>b;b++)a(this.source[b])},empty:function(){var a=this.currentLocation||{start:{}};return new g(a.start.line,a.start.column,this.srcFile)},wrap:function(a){var b=arguments.length<=1||void 0===arguments[1]?this.currentLocation||{start:{}}:arguments[1];return a instanceof g?a:(a=d(a,this,b),new g(b.start.line,b.start.column,this.srcFile,a))},functionCall:function(a,b,c){return c=this.generateList(c),this.wrap([a,b?"."+b+"(":"(",c,")"])},quotedString:function(a){return'"'+(a+"").replace(/\\/g,"\\\\").replace(/"/g,'\\"').replace(/\n/g,"\\n").replace(/\r/g,"\\r").replace(/\u2028/g,"\\u2028").replace(/\u2029/g,"\\u2029")+'"'},objectLiteral:function(a){var b=[];for(var c in a)if(a.hasOwnProperty(c)){var e=d(a[c],this);"undefined"!==e&&b.push([this.quotedString(c),":",e])}var f=this.generateList(b);return f.prepend("{"),f.add("}"),f},generateList:function(a){for(var b=this.empty(),c=0,e=a.length;e>c;c++)c&&b.add(","),b.add(d(a[c],this));return b},generateArray:function(a){var b=this.generateList(a);return b.prepend("["),b.add("]"),b}},b["default"]=e,a.exports=b["default"]}])}); \ No newline at end of file diff --git a/backend/docs/vendor/jquery.min.js b/backend/docs/vendor/jquery.min.js new file mode 100644 index 00000000000..349030de995 --- /dev/null +++ b/backend/docs/vendor/jquery.min.js @@ -0,0 +1,4 @@ +/*! jQuery v2.2.1 | (c) jQuery Foundation | jquery.org/license */ +!function(a,b){"object"==typeof module&&"object"==typeof module.exports?module.exports=a.document?b(a,!0):function(a){if(!a.document)throw new Error("jQuery requires a window with a document");return b(a)}:b(a)}("undefined"!=typeof window?window:this,function(a,b){var c=[],d=a.document,e=c.slice,f=c.concat,g=c.push,h=c.indexOf,i={},j=i.toString,k=i.hasOwnProperty,l={},m="2.2.1",n=function(a,b){return new n.fn.init(a,b)},o=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,p=/^-ms-/,q=/-([\da-z])/gi,r=function(a,b){return b.toUpperCase()};n.fn=n.prototype={jquery:m,constructor:n,selector:"",length:0,toArray:function(){return e.call(this)},get:function(a){return null!=a?0>a?this[a+this.length]:this[a]:e.call(this)},pushStack:function(a){var b=n.merge(this.constructor(),a);return b.prevObject=this,b.context=this.context,b},each:function(a){return n.each(this,a)},map:function(a){return this.pushStack(n.map(this,function(b,c){return a.call(b,c,b)}))},slice:function(){return this.pushStack(e.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(a){var b=this.length,c=+a+(0>a?b:0);return this.pushStack(c>=0&&b>c?[this[c]]:[])},end:function(){return this.prevObject||this.constructor()},push:g,sort:c.sort,splice:c.splice},n.extend=n.fn.extend=function(){var a,b,c,d,e,f,g=arguments[0]||{},h=1,i=arguments.length,j=!1;for("boolean"==typeof g&&(j=g,g=arguments[h]||{},h++),"object"==typeof g||n.isFunction(g)||(g={}),h===i&&(g=this,h--);i>h;h++)if(null!=(a=arguments[h]))for(b in a)c=g[b],d=a[b],g!==d&&(j&&d&&(n.isPlainObject(d)||(e=n.isArray(d)))?(e?(e=!1,f=c&&n.isArray(c)?c:[]):f=c&&n.isPlainObject(c)?c:{},g[b]=n.extend(j,f,d)):void 0!==d&&(g[b]=d));return g},n.extend({expando:"jQuery"+(m+Math.random()).replace(/\D/g,""),isReady:!0,error:function(a){throw new Error(a)},noop:function(){},isFunction:function(a){return"function"===n.type(a)},isArray:Array.isArray,isWindow:function(a){return null!=a&&a===a.window},isNumeric:function(a){var b=a&&a.toString();return!n.isArray(a)&&b-parseFloat(b)+1>=0},isPlainObject:function(a){return"object"!==n.type(a)||a.nodeType||n.isWindow(a)?!1:a.constructor&&!k.call(a.constructor.prototype,"isPrototypeOf")?!1:!0},isEmptyObject:function(a){var b;for(b in a)return!1;return!0},type:function(a){return null==a?a+"":"object"==typeof a||"function"==typeof a?i[j.call(a)]||"object":typeof a},globalEval:function(a){var b,c=eval;a=n.trim(a),a&&(1===a.indexOf("use strict")?(b=d.createElement("script"),b.text=a,d.head.appendChild(b).parentNode.removeChild(b)):c(a))},camelCase:function(a){return a.replace(p,"ms-").replace(q,r)},nodeName:function(a,b){return a.nodeName&&a.nodeName.toLowerCase()===b.toLowerCase()},each:function(a,b){var c,d=0;if(s(a)){for(c=a.length;c>d;d++)if(b.call(a[d],d,a[d])===!1)break}else for(d in a)if(b.call(a[d],d,a[d])===!1)break;return a},trim:function(a){return null==a?"":(a+"").replace(o,"")},makeArray:function(a,b){var c=b||[];return null!=a&&(s(Object(a))?n.merge(c,"string"==typeof a?[a]:a):g.call(c,a)),c},inArray:function(a,b,c){return null==b?-1:h.call(b,a,c)},merge:function(a,b){for(var c=+b.length,d=0,e=a.length;c>d;d++)a[e++]=b[d];return a.length=e,a},grep:function(a,b,c){for(var d,e=[],f=0,g=a.length,h=!c;g>f;f++)d=!b(a[f],f),d!==h&&e.push(a[f]);return e},map:function(a,b,c){var d,e,g=0,h=[];if(s(a))for(d=a.length;d>g;g++)e=b(a[g],g,c),null!=e&&h.push(e);else for(g in a)e=b(a[g],g,c),null!=e&&h.push(e);return f.apply([],h)},guid:1,proxy:function(a,b){var c,d,f;return"string"==typeof b&&(c=a[b],b=a,a=c),n.isFunction(a)?(d=e.call(arguments,2),f=function(){return a.apply(b||this,d.concat(e.call(arguments)))},f.guid=a.guid=a.guid||n.guid++,f):void 0},now:Date.now,support:l}),"function"==typeof Symbol&&(n.fn[Symbol.iterator]=c[Symbol.iterator]),n.each("Boolean Number String Function Array Date RegExp Object Error Symbol".split(" "),function(a,b){i["[object "+b+"]"]=b.toLowerCase()});function s(a){var b=!!a&&"length"in a&&a.length,c=n.type(a);return"function"===c||n.isWindow(a)?!1:"array"===c||0===b||"number"==typeof b&&b>0&&b-1 in a}var t=function(a){var b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u="sizzle"+1*new Date,v=a.document,w=0,x=0,y=ga(),z=ga(),A=ga(),B=function(a,b){return a===b&&(l=!0),0},C=1<<31,D={}.hasOwnProperty,E=[],F=E.pop,G=E.push,H=E.push,I=E.slice,J=function(a,b){for(var c=0,d=a.length;d>c;c++)if(a[c]===b)return c;return-1},K="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",L="[\\x20\\t\\r\\n\\f]",M="(?:\\\\.|[\\w-]|[^\\x00-\\xa0])+",N="\\["+L+"*("+M+")(?:"+L+"*([*^$|!~]?=)"+L+"*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|("+M+"))|)"+L+"*\\]",O=":("+M+")(?:\\((('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|((?:\\\\.|[^\\\\()[\\]]|"+N+")*)|.*)\\)|)",P=new RegExp(L+"+","g"),Q=new RegExp("^"+L+"+|((?:^|[^\\\\])(?:\\\\.)*)"+L+"+$","g"),R=new RegExp("^"+L+"*,"+L+"*"),S=new RegExp("^"+L+"*([>+~]|"+L+")"+L+"*"),T=new RegExp("="+L+"*([^\\]'\"]*?)"+L+"*\\]","g"),U=new RegExp(O),V=new RegExp("^"+M+"$"),W={ID:new RegExp("^#("+M+")"),CLASS:new RegExp("^\\.("+M+")"),TAG:new RegExp("^("+M+"|[*])"),ATTR:new RegExp("^"+N),PSEUDO:new RegExp("^"+O),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+L+"*(even|odd|(([+-]|)(\\d*)n|)"+L+"*(?:([+-]|)"+L+"*(\\d+)|))"+L+"*\\)|)","i"),bool:new RegExp("^(?:"+K+")$","i"),needsContext:new RegExp("^"+L+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+L+"*((?:-\\d)?\\d*)"+L+"*\\)|)(?=[^-]|$)","i")},X=/^(?:input|select|textarea|button)$/i,Y=/^h\d$/i,Z=/^[^{]+\{\s*\[native \w/,$=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,_=/[+~]/,aa=/'|\\/g,ba=new RegExp("\\\\([\\da-f]{1,6}"+L+"?|("+L+")|.)","ig"),ca=function(a,b,c){var d="0x"+b-65536;return d!==d||c?b:0>d?String.fromCharCode(d+65536):String.fromCharCode(d>>10|55296,1023&d|56320)},da=function(){m()};try{H.apply(E=I.call(v.childNodes),v.childNodes),E[v.childNodes.length].nodeType}catch(ea){H={apply:E.length?function(a,b){G.apply(a,I.call(b))}:function(a,b){var c=a.length,d=0;while(a[c++]=b[d++]);a.length=c-1}}}function fa(a,b,d,e){var f,h,j,k,l,o,r,s,w=b&&b.ownerDocument,x=b?b.nodeType:9;if(d=d||[],"string"!=typeof a||!a||1!==x&&9!==x&&11!==x)return d;if(!e&&((b?b.ownerDocument||b:v)!==n&&m(b),b=b||n,p)){if(11!==x&&(o=$.exec(a)))if(f=o[1]){if(9===x){if(!(j=b.getElementById(f)))return d;if(j.id===f)return d.push(j),d}else if(w&&(j=w.getElementById(f))&&t(b,j)&&j.id===f)return d.push(j),d}else{if(o[2])return H.apply(d,b.getElementsByTagName(a)),d;if((f=o[3])&&c.getElementsByClassName&&b.getElementsByClassName)return H.apply(d,b.getElementsByClassName(f)),d}if(c.qsa&&!A[a+" "]&&(!q||!q.test(a))){if(1!==x)w=b,s=a;else if("object"!==b.nodeName.toLowerCase()){(k=b.getAttribute("id"))?k=k.replace(aa,"\\$&"):b.setAttribute("id",k=u),r=g(a),h=r.length,l=V.test(k)?"#"+k:"[id='"+k+"']";while(h--)r[h]=l+" "+qa(r[h]);s=r.join(","),w=_.test(a)&&oa(b.parentNode)||b}if(s)try{return H.apply(d,w.querySelectorAll(s)),d}catch(y){}finally{k===u&&b.removeAttribute("id")}}}return i(a.replace(Q,"$1"),b,d,e)}function ga(){var a=[];function b(c,e){return a.push(c+" ")>d.cacheLength&&delete b[a.shift()],b[c+" "]=e}return b}function ha(a){return a[u]=!0,a}function ia(a){var b=n.createElement("div");try{return!!a(b)}catch(c){return!1}finally{b.parentNode&&b.parentNode.removeChild(b),b=null}}function ja(a,b){var c=a.split("|"),e=c.length;while(e--)d.attrHandle[c[e]]=b}function ka(a,b){var c=b&&a,d=c&&1===a.nodeType&&1===b.nodeType&&(~b.sourceIndex||C)-(~a.sourceIndex||C);if(d)return d;if(c)while(c=c.nextSibling)if(c===b)return-1;return a?1:-1}function la(a){return function(b){var c=b.nodeName.toLowerCase();return"input"===c&&b.type===a}}function ma(a){return function(b){var c=b.nodeName.toLowerCase();return("input"===c||"button"===c)&&b.type===a}}function na(a){return ha(function(b){return b=+b,ha(function(c,d){var e,f=a([],c.length,b),g=f.length;while(g--)c[e=f[g]]&&(c[e]=!(d[e]=c[e]))})})}function oa(a){return a&&"undefined"!=typeof a.getElementsByTagName&&a}c=fa.support={},f=fa.isXML=function(a){var b=a&&(a.ownerDocument||a).documentElement;return b?"HTML"!==b.nodeName:!1},m=fa.setDocument=function(a){var b,e,g=a?a.ownerDocument||a:v;return g!==n&&9===g.nodeType&&g.documentElement?(n=g,o=n.documentElement,p=!f(n),(e=n.defaultView)&&e.top!==e&&(e.addEventListener?e.addEventListener("unload",da,!1):e.attachEvent&&e.attachEvent("onunload",da)),c.attributes=ia(function(a){return a.className="i",!a.getAttribute("className")}),c.getElementsByTagName=ia(function(a){return a.appendChild(n.createComment("")),!a.getElementsByTagName("*").length}),c.getElementsByClassName=Z.test(n.getElementsByClassName),c.getById=ia(function(a){return o.appendChild(a).id=u,!n.getElementsByName||!n.getElementsByName(u).length}),c.getById?(d.find.ID=function(a,b){if("undefined"!=typeof b.getElementById&&p){var c=b.getElementById(a);return c?[c]:[]}},d.filter.ID=function(a){var b=a.replace(ba,ca);return function(a){return a.getAttribute("id")===b}}):(delete d.find.ID,d.filter.ID=function(a){var b=a.replace(ba,ca);return function(a){var c="undefined"!=typeof a.getAttributeNode&&a.getAttributeNode("id");return c&&c.value===b}}),d.find.TAG=c.getElementsByTagName?function(a,b){return"undefined"!=typeof b.getElementsByTagName?b.getElementsByTagName(a):c.qsa?b.querySelectorAll(a):void 0}:function(a,b){var c,d=[],e=0,f=b.getElementsByTagName(a);if("*"===a){while(c=f[e++])1===c.nodeType&&d.push(c);return d}return f},d.find.CLASS=c.getElementsByClassName&&function(a,b){return"undefined"!=typeof b.getElementsByClassName&&p?b.getElementsByClassName(a):void 0},r=[],q=[],(c.qsa=Z.test(n.querySelectorAll))&&(ia(function(a){o.appendChild(a).innerHTML="",a.querySelectorAll("[msallowcapture^='']").length&&q.push("[*^$]="+L+"*(?:''|\"\")"),a.querySelectorAll("[selected]").length||q.push("\\["+L+"*(?:value|"+K+")"),a.querySelectorAll("[id~="+u+"-]").length||q.push("~="),a.querySelectorAll(":checked").length||q.push(":checked"),a.querySelectorAll("a#"+u+"+*").length||q.push(".#.+[+~]")}),ia(function(a){var b=n.createElement("input");b.setAttribute("type","hidden"),a.appendChild(b).setAttribute("name","D"),a.querySelectorAll("[name=d]").length&&q.push("name"+L+"*[*^$|!~]?="),a.querySelectorAll(":enabled").length||q.push(":enabled",":disabled"),a.querySelectorAll("*,:x"),q.push(",.*:")})),(c.matchesSelector=Z.test(s=o.matches||o.webkitMatchesSelector||o.mozMatchesSelector||o.oMatchesSelector||o.msMatchesSelector))&&ia(function(a){c.disconnectedMatch=s.call(a,"div"),s.call(a,"[s!='']:x"),r.push("!=",O)}),q=q.length&&new RegExp(q.join("|")),r=r.length&&new RegExp(r.join("|")),b=Z.test(o.compareDocumentPosition),t=b||Z.test(o.contains)?function(a,b){var c=9===a.nodeType?a.documentElement:a,d=b&&b.parentNode;return a===d||!(!d||1!==d.nodeType||!(c.contains?c.contains(d):a.compareDocumentPosition&&16&a.compareDocumentPosition(d)))}:function(a,b){if(b)while(b=b.parentNode)if(b===a)return!0;return!1},B=b?function(a,b){if(a===b)return l=!0,0;var d=!a.compareDocumentPosition-!b.compareDocumentPosition;return d?d:(d=(a.ownerDocument||a)===(b.ownerDocument||b)?a.compareDocumentPosition(b):1,1&d||!c.sortDetached&&b.compareDocumentPosition(a)===d?a===n||a.ownerDocument===v&&t(v,a)?-1:b===n||b.ownerDocument===v&&t(v,b)?1:k?J(k,a)-J(k,b):0:4&d?-1:1)}:function(a,b){if(a===b)return l=!0,0;var c,d=0,e=a.parentNode,f=b.parentNode,g=[a],h=[b];if(!e||!f)return a===n?-1:b===n?1:e?-1:f?1:k?J(k,a)-J(k,b):0;if(e===f)return ka(a,b);c=a;while(c=c.parentNode)g.unshift(c);c=b;while(c=c.parentNode)h.unshift(c);while(g[d]===h[d])d++;return d?ka(g[d],h[d]):g[d]===v?-1:h[d]===v?1:0},n):n},fa.matches=function(a,b){return fa(a,null,null,b)},fa.matchesSelector=function(a,b){if((a.ownerDocument||a)!==n&&m(a),b=b.replace(T,"='$1']"),c.matchesSelector&&p&&!A[b+" "]&&(!r||!r.test(b))&&(!q||!q.test(b)))try{var d=s.call(a,b);if(d||c.disconnectedMatch||a.document&&11!==a.document.nodeType)return d}catch(e){}return fa(b,n,null,[a]).length>0},fa.contains=function(a,b){return(a.ownerDocument||a)!==n&&m(a),t(a,b)},fa.attr=function(a,b){(a.ownerDocument||a)!==n&&m(a);var e=d.attrHandle[b.toLowerCase()],f=e&&D.call(d.attrHandle,b.toLowerCase())?e(a,b,!p):void 0;return void 0!==f?f:c.attributes||!p?a.getAttribute(b):(f=a.getAttributeNode(b))&&f.specified?f.value:null},fa.error=function(a){throw new Error("Syntax error, unrecognized expression: "+a)},fa.uniqueSort=function(a){var b,d=[],e=0,f=0;if(l=!c.detectDuplicates,k=!c.sortStable&&a.slice(0),a.sort(B),l){while(b=a[f++])b===a[f]&&(e=d.push(f));while(e--)a.splice(d[e],1)}return k=null,a},e=fa.getText=function(a){var b,c="",d=0,f=a.nodeType;if(f){if(1===f||9===f||11===f){if("string"==typeof a.textContent)return a.textContent;for(a=a.firstChild;a;a=a.nextSibling)c+=e(a)}else if(3===f||4===f)return a.nodeValue}else while(b=a[d++])c+=e(b);return c},d=fa.selectors={cacheLength:50,createPseudo:ha,match:W,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(a){return a[1]=a[1].replace(ba,ca),a[3]=(a[3]||a[4]||a[5]||"").replace(ba,ca),"~="===a[2]&&(a[3]=" "+a[3]+" "),a.slice(0,4)},CHILD:function(a){return a[1]=a[1].toLowerCase(),"nth"===a[1].slice(0,3)?(a[3]||fa.error(a[0]),a[4]=+(a[4]?a[5]+(a[6]||1):2*("even"===a[3]||"odd"===a[3])),a[5]=+(a[7]+a[8]||"odd"===a[3])):a[3]&&fa.error(a[0]),a},PSEUDO:function(a){var b,c=!a[6]&&a[2];return W.CHILD.test(a[0])?null:(a[3]?a[2]=a[4]||a[5]||"":c&&U.test(c)&&(b=g(c,!0))&&(b=c.indexOf(")",c.length-b)-c.length)&&(a[0]=a[0].slice(0,b),a[2]=c.slice(0,b)),a.slice(0,3))}},filter:{TAG:function(a){var b=a.replace(ba,ca).toLowerCase();return"*"===a?function(){return!0}:function(a){return a.nodeName&&a.nodeName.toLowerCase()===b}},CLASS:function(a){var b=y[a+" "];return b||(b=new RegExp("(^|"+L+")"+a+"("+L+"|$)"))&&y(a,function(a){return b.test("string"==typeof a.className&&a.className||"undefined"!=typeof a.getAttribute&&a.getAttribute("class")||"")})},ATTR:function(a,b,c){return function(d){var e=fa.attr(d,a);return null==e?"!="===b:b?(e+="","="===b?e===c:"!="===b?e!==c:"^="===b?c&&0===e.indexOf(c):"*="===b?c&&e.indexOf(c)>-1:"$="===b?c&&e.slice(-c.length)===c:"~="===b?(" "+e.replace(P," ")+" ").indexOf(c)>-1:"|="===b?e===c||e.slice(0,c.length+1)===c+"-":!1):!0}},CHILD:function(a,b,c,d,e){var f="nth"!==a.slice(0,3),g="last"!==a.slice(-4),h="of-type"===b;return 1===d&&0===e?function(a){return!!a.parentNode}:function(b,c,i){var j,k,l,m,n,o,p=f!==g?"nextSibling":"previousSibling",q=b.parentNode,r=h&&b.nodeName.toLowerCase(),s=!i&&!h,t=!1;if(q){if(f){while(p){m=b;while(m=m[p])if(h?m.nodeName.toLowerCase()===r:1===m.nodeType)return!1;o=p="only"===a&&!o&&"nextSibling"}return!0}if(o=[g?q.firstChild:q.lastChild],g&&s){m=q,l=m[u]||(m[u]={}),k=l[m.uniqueID]||(l[m.uniqueID]={}),j=k[a]||[],n=j[0]===w&&j[1],t=n&&j[2],m=n&&q.childNodes[n];while(m=++n&&m&&m[p]||(t=n=0)||o.pop())if(1===m.nodeType&&++t&&m===b){k[a]=[w,n,t];break}}else if(s&&(m=b,l=m[u]||(m[u]={}),k=l[m.uniqueID]||(l[m.uniqueID]={}),j=k[a]||[],n=j[0]===w&&j[1],t=n),t===!1)while(m=++n&&m&&m[p]||(t=n=0)||o.pop())if((h?m.nodeName.toLowerCase()===r:1===m.nodeType)&&++t&&(s&&(l=m[u]||(m[u]={}),k=l[m.uniqueID]||(l[m.uniqueID]={}),k[a]=[w,t]),m===b))break;return t-=e,t===d||t%d===0&&t/d>=0}}},PSEUDO:function(a,b){var c,e=d.pseudos[a]||d.setFilters[a.toLowerCase()]||fa.error("unsupported pseudo: "+a);return e[u]?e(b):e.length>1?(c=[a,a,"",b],d.setFilters.hasOwnProperty(a.toLowerCase())?ha(function(a,c){var d,f=e(a,b),g=f.length;while(g--)d=J(a,f[g]),a[d]=!(c[d]=f[g])}):function(a){return e(a,0,c)}):e}},pseudos:{not:ha(function(a){var b=[],c=[],d=h(a.replace(Q,"$1"));return d[u]?ha(function(a,b,c,e){var f,g=d(a,null,e,[]),h=a.length;while(h--)(f=g[h])&&(a[h]=!(b[h]=f))}):function(a,e,f){return b[0]=a,d(b,null,f,c),b[0]=null,!c.pop()}}),has:ha(function(a){return function(b){return fa(a,b).length>0}}),contains:ha(function(a){return a=a.replace(ba,ca),function(b){return(b.textContent||b.innerText||e(b)).indexOf(a)>-1}}),lang:ha(function(a){return V.test(a||"")||fa.error("unsupported lang: "+a),a=a.replace(ba,ca).toLowerCase(),function(b){var c;do if(c=p?b.lang:b.getAttribute("xml:lang")||b.getAttribute("lang"))return c=c.toLowerCase(),c===a||0===c.indexOf(a+"-");while((b=b.parentNode)&&1===b.nodeType);return!1}}),target:function(b){var c=a.location&&a.location.hash;return c&&c.slice(1)===b.id},root:function(a){return a===o},focus:function(a){return a===n.activeElement&&(!n.hasFocus||n.hasFocus())&&!!(a.type||a.href||~a.tabIndex)},enabled:function(a){return a.disabled===!1},disabled:function(a){return a.disabled===!0},checked:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&!!a.checked||"option"===b&&!!a.selected},selected:function(a){return a.parentNode&&a.parentNode.selectedIndex,a.selected===!0},empty:function(a){for(a=a.firstChild;a;a=a.nextSibling)if(a.nodeType<6)return!1;return!0},parent:function(a){return!d.pseudos.empty(a)},header:function(a){return Y.test(a.nodeName)},input:function(a){return X.test(a.nodeName)},button:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&"button"===a.type||"button"===b},text:function(a){var b;return"input"===a.nodeName.toLowerCase()&&"text"===a.type&&(null==(b=a.getAttribute("type"))||"text"===b.toLowerCase())},first:na(function(){return[0]}),last:na(function(a,b){return[b-1]}),eq:na(function(a,b,c){return[0>c?c+b:c]}),even:na(function(a,b){for(var c=0;b>c;c+=2)a.push(c);return a}),odd:na(function(a,b){for(var c=1;b>c;c+=2)a.push(c);return a}),lt:na(function(a,b,c){for(var d=0>c?c+b:c;--d>=0;)a.push(d);return a}),gt:na(function(a,b,c){for(var d=0>c?c+b:c;++db;b++)d+=a[b].value;return d}function ra(a,b,c){var d=b.dir,e=c&&"parentNode"===d,f=x++;return b.first?function(b,c,f){while(b=b[d])if(1===b.nodeType||e)return a(b,c,f)}:function(b,c,g){var h,i,j,k=[w,f];if(g){while(b=b[d])if((1===b.nodeType||e)&&a(b,c,g))return!0}else while(b=b[d])if(1===b.nodeType||e){if(j=b[u]||(b[u]={}),i=j[b.uniqueID]||(j[b.uniqueID]={}),(h=i[d])&&h[0]===w&&h[1]===f)return k[2]=h[2];if(i[d]=k,k[2]=a(b,c,g))return!0}}}function sa(a){return a.length>1?function(b,c,d){var e=a.length;while(e--)if(!a[e](b,c,d))return!1;return!0}:a[0]}function ta(a,b,c){for(var d=0,e=b.length;e>d;d++)fa(a,b[d],c);return c}function ua(a,b,c,d,e){for(var f,g=[],h=0,i=a.length,j=null!=b;i>h;h++)(f=a[h])&&(!c||c(f,d,e))&&(g.push(f),j&&b.push(h));return g}function va(a,b,c,d,e,f){return d&&!d[u]&&(d=va(d)),e&&!e[u]&&(e=va(e,f)),ha(function(f,g,h,i){var j,k,l,m=[],n=[],o=g.length,p=f||ta(b||"*",h.nodeType?[h]:h,[]),q=!a||!f&&b?p:ua(p,m,a,h,i),r=c?e||(f?a:o||d)?[]:g:q;if(c&&c(q,r,h,i),d){j=ua(r,n),d(j,[],h,i),k=j.length;while(k--)(l=j[k])&&(r[n[k]]=!(q[n[k]]=l))}if(f){if(e||a){if(e){j=[],k=r.length;while(k--)(l=r[k])&&j.push(q[k]=l);e(null,r=[],j,i)}k=r.length;while(k--)(l=r[k])&&(j=e?J(f,l):m[k])>-1&&(f[j]=!(g[j]=l))}}else r=ua(r===g?r.splice(o,r.length):r),e?e(null,g,r,i):H.apply(g,r)})}function wa(a){for(var b,c,e,f=a.length,g=d.relative[a[0].type],h=g||d.relative[" "],i=g?1:0,k=ra(function(a){return a===b},h,!0),l=ra(function(a){return J(b,a)>-1},h,!0),m=[function(a,c,d){var e=!g&&(d||c!==j)||((b=c).nodeType?k(a,c,d):l(a,c,d));return b=null,e}];f>i;i++)if(c=d.relative[a[i].type])m=[ra(sa(m),c)];else{if(c=d.filter[a[i].type].apply(null,a[i].matches),c[u]){for(e=++i;f>e;e++)if(d.relative[a[e].type])break;return va(i>1&&sa(m),i>1&&qa(a.slice(0,i-1).concat({value:" "===a[i-2].type?"*":""})).replace(Q,"$1"),c,e>i&&wa(a.slice(i,e)),f>e&&wa(a=a.slice(e)),f>e&&qa(a))}m.push(c)}return sa(m)}function xa(a,b){var c=b.length>0,e=a.length>0,f=function(f,g,h,i,k){var l,o,q,r=0,s="0",t=f&&[],u=[],v=j,x=f||e&&d.find.TAG("*",k),y=w+=null==v?1:Math.random()||.1,z=x.length;for(k&&(j=g===n||g||k);s!==z&&null!=(l=x[s]);s++){if(e&&l){o=0,g||l.ownerDocument===n||(m(l),h=!p);while(q=a[o++])if(q(l,g||n,h)){i.push(l);break}k&&(w=y)}c&&((l=!q&&l)&&r--,f&&t.push(l))}if(r+=s,c&&s!==r){o=0;while(q=b[o++])q(t,u,g,h);if(f){if(r>0)while(s--)t[s]||u[s]||(u[s]=F.call(i));u=ua(u)}H.apply(i,u),k&&!f&&u.length>0&&r+b.length>1&&fa.uniqueSort(i)}return k&&(w=y,j=v),t};return c?ha(f):f}return h=fa.compile=function(a,b){var c,d=[],e=[],f=A[a+" "];if(!f){b||(b=g(a)),c=b.length;while(c--)f=wa(b[c]),f[u]?d.push(f):e.push(f);f=A(a,xa(e,d)),f.selector=a}return f},i=fa.select=function(a,b,e,f){var i,j,k,l,m,n="function"==typeof a&&a,o=!f&&g(a=n.selector||a);if(e=e||[],1===o.length){if(j=o[0]=o[0].slice(0),j.length>2&&"ID"===(k=j[0]).type&&c.getById&&9===b.nodeType&&p&&d.relative[j[1].type]){if(b=(d.find.ID(k.matches[0].replace(ba,ca),b)||[])[0],!b)return e;n&&(b=b.parentNode),a=a.slice(j.shift().value.length)}i=W.needsContext.test(a)?0:j.length;while(i--){if(k=j[i],d.relative[l=k.type])break;if((m=d.find[l])&&(f=m(k.matches[0].replace(ba,ca),_.test(j[0].type)&&oa(b.parentNode)||b))){if(j.splice(i,1),a=f.length&&qa(j),!a)return H.apply(e,f),e;break}}}return(n||h(a,o))(f,b,!p,e,!b||_.test(a)&&oa(b.parentNode)||b),e},c.sortStable=u.split("").sort(B).join("")===u,c.detectDuplicates=!!l,m(),c.sortDetached=ia(function(a){return 1&a.compareDocumentPosition(n.createElement("div"))}),ia(function(a){return a.innerHTML="","#"===a.firstChild.getAttribute("href")})||ja("type|href|height|width",function(a,b,c){return c?void 0:a.getAttribute(b,"type"===b.toLowerCase()?1:2)}),c.attributes&&ia(function(a){return a.innerHTML="",a.firstChild.setAttribute("value",""),""===a.firstChild.getAttribute("value")})||ja("value",function(a,b,c){return c||"input"!==a.nodeName.toLowerCase()?void 0:a.defaultValue}),ia(function(a){return null==a.getAttribute("disabled")})||ja(K,function(a,b,c){var d;return c?void 0:a[b]===!0?b.toLowerCase():(d=a.getAttributeNode(b))&&d.specified?d.value:null}),fa}(a);n.find=t,n.expr=t.selectors,n.expr[":"]=n.expr.pseudos,n.uniqueSort=n.unique=t.uniqueSort,n.text=t.getText,n.isXMLDoc=t.isXML,n.contains=t.contains;var u=function(a,b,c){var d=[],e=void 0!==c;while((a=a[b])&&9!==a.nodeType)if(1===a.nodeType){if(e&&n(a).is(c))break;d.push(a)}return d},v=function(a,b){for(var c=[];a;a=a.nextSibling)1===a.nodeType&&a!==b&&c.push(a);return c},w=n.expr.match.needsContext,x=/^<([\w-]+)\s*\/?>(?:<\/\1>|)$/,y=/^.[^:#\[\.,]*$/;function z(a,b,c){if(n.isFunction(b))return n.grep(a,function(a,d){return!!b.call(a,d,a)!==c});if(b.nodeType)return n.grep(a,function(a){return a===b!==c});if("string"==typeof b){if(y.test(b))return n.filter(b,a,c);b=n.filter(b,a)}return n.grep(a,function(a){return h.call(b,a)>-1!==c})}n.filter=function(a,b,c){var d=b[0];return c&&(a=":not("+a+")"),1===b.length&&1===d.nodeType?n.find.matchesSelector(d,a)?[d]:[]:n.find.matches(a,n.grep(b,function(a){return 1===a.nodeType}))},n.fn.extend({find:function(a){var b,c=this.length,d=[],e=this;if("string"!=typeof a)return this.pushStack(n(a).filter(function(){for(b=0;c>b;b++)if(n.contains(e[b],this))return!0}));for(b=0;c>b;b++)n.find(a,e[b],d);return d=this.pushStack(c>1?n.unique(d):d),d.selector=this.selector?this.selector+" "+a:a,d},filter:function(a){return this.pushStack(z(this,a||[],!1))},not:function(a){return this.pushStack(z(this,a||[],!0))},is:function(a){return!!z(this,"string"==typeof a&&w.test(a)?n(a):a||[],!1).length}});var A,B=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]*))$/,C=n.fn.init=function(a,b,c){var e,f;if(!a)return this;if(c=c||A,"string"==typeof a){if(e="<"===a[0]&&">"===a[a.length-1]&&a.length>=3?[null,a,null]:B.exec(a),!e||!e[1]&&b)return!b||b.jquery?(b||c).find(a):this.constructor(b).find(a);if(e[1]){if(b=b instanceof n?b[0]:b,n.merge(this,n.parseHTML(e[1],b&&b.nodeType?b.ownerDocument||b:d,!0)),x.test(e[1])&&n.isPlainObject(b))for(e in b)n.isFunction(this[e])?this[e](b[e]):this.attr(e,b[e]);return this}return f=d.getElementById(e[2]),f&&f.parentNode&&(this.length=1,this[0]=f),this.context=d,this.selector=a,this}return a.nodeType?(this.context=this[0]=a,this.length=1,this):n.isFunction(a)?void 0!==c.ready?c.ready(a):a(n):(void 0!==a.selector&&(this.selector=a.selector,this.context=a.context),n.makeArray(a,this))};C.prototype=n.fn,A=n(d);var D=/^(?:parents|prev(?:Until|All))/,E={children:!0,contents:!0,next:!0,prev:!0};n.fn.extend({has:function(a){var b=n(a,this),c=b.length;return this.filter(function(){for(var a=0;c>a;a++)if(n.contains(this,b[a]))return!0})},closest:function(a,b){for(var c,d=0,e=this.length,f=[],g=w.test(a)||"string"!=typeof a?n(a,b||this.context):0;e>d;d++)for(c=this[d];c&&c!==b;c=c.parentNode)if(c.nodeType<11&&(g?g.index(c)>-1:1===c.nodeType&&n.find.matchesSelector(c,a))){f.push(c);break}return this.pushStack(f.length>1?n.uniqueSort(f):f)},index:function(a){return a?"string"==typeof a?h.call(n(a),this[0]):h.call(this,a.jquery?a[0]:a):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(a,b){return this.pushStack(n.uniqueSort(n.merge(this.get(),n(a,b))))},addBack:function(a){return this.add(null==a?this.prevObject:this.prevObject.filter(a))}});function F(a,b){while((a=a[b])&&1!==a.nodeType);return a}n.each({parent:function(a){var b=a.parentNode;return b&&11!==b.nodeType?b:null},parents:function(a){return u(a,"parentNode")},parentsUntil:function(a,b,c){return u(a,"parentNode",c)},next:function(a){return F(a,"nextSibling")},prev:function(a){return F(a,"previousSibling")},nextAll:function(a){return u(a,"nextSibling")},prevAll:function(a){return u(a,"previousSibling")},nextUntil:function(a,b,c){return u(a,"nextSibling",c)},prevUntil:function(a,b,c){return u(a,"previousSibling",c)},siblings:function(a){return v((a.parentNode||{}).firstChild,a)},children:function(a){return v(a.firstChild)},contents:function(a){return a.contentDocument||n.merge([],a.childNodes)}},function(a,b){n.fn[a]=function(c,d){var e=n.map(this,b,c);return"Until"!==a.slice(-5)&&(d=c),d&&"string"==typeof d&&(e=n.filter(d,e)),this.length>1&&(E[a]||n.uniqueSort(e),D.test(a)&&e.reverse()),this.pushStack(e)}});var G=/\S+/g;function H(a){var b={};return n.each(a.match(G)||[],function(a,c){b[c]=!0}),b}n.Callbacks=function(a){a="string"==typeof a?H(a):n.extend({},a);var b,c,d,e,f=[],g=[],h=-1,i=function(){for(e=a.once,d=b=!0;g.length;h=-1){c=g.shift();while(++h-1)f.splice(c,1),h>=c&&h--}),this},has:function(a){return a?n.inArray(a,f)>-1:f.length>0},empty:function(){return f&&(f=[]),this},disable:function(){return e=g=[],f=c="",this},disabled:function(){return!f},lock:function(){return e=g=[],c||(f=c=""),this},locked:function(){return!!e},fireWith:function(a,c){return e||(c=c||[],c=[a,c.slice?c.slice():c],g.push(c),b||i()),this},fire:function(){return j.fireWith(this,arguments),this},fired:function(){return!!d}};return j},n.extend({Deferred:function(a){var b=[["resolve","done",n.Callbacks("once memory"),"resolved"],["reject","fail",n.Callbacks("once memory"),"rejected"],["notify","progress",n.Callbacks("memory")]],c="pending",d={state:function(){return c},always:function(){return e.done(arguments).fail(arguments),this},then:function(){var a=arguments;return n.Deferred(function(c){n.each(b,function(b,f){var g=n.isFunction(a[b])&&a[b];e[f[1]](function(){var a=g&&g.apply(this,arguments);a&&n.isFunction(a.promise)?a.promise().progress(c.notify).done(c.resolve).fail(c.reject):c[f[0]+"With"](this===d?c.promise():this,g?[a]:arguments)})}),a=null}).promise()},promise:function(a){return null!=a?n.extend(a,d):d}},e={};return d.pipe=d.then,n.each(b,function(a,f){var g=f[2],h=f[3];d[f[1]]=g.add,h&&g.add(function(){c=h},b[1^a][2].disable,b[2][2].lock),e[f[0]]=function(){return e[f[0]+"With"](this===e?d:this,arguments),this},e[f[0]+"With"]=g.fireWith}),d.promise(e),a&&a.call(e,e),e},when:function(a){var b=0,c=e.call(arguments),d=c.length,f=1!==d||a&&n.isFunction(a.promise)?d:0,g=1===f?a:n.Deferred(),h=function(a,b,c){return function(d){b[a]=this,c[a]=arguments.length>1?e.call(arguments):d,c===i?g.notifyWith(b,c):--f||g.resolveWith(b,c)}},i,j,k;if(d>1)for(i=new Array(d),j=new Array(d),k=new Array(d);d>b;b++)c[b]&&n.isFunction(c[b].promise)?c[b].promise().progress(h(b,j,i)).done(h(b,k,c)).fail(g.reject):--f;return f||g.resolveWith(k,c),g.promise()}});var I;n.fn.ready=function(a){return n.ready.promise().done(a),this},n.extend({isReady:!1,readyWait:1,holdReady:function(a){a?n.readyWait++:n.ready(!0)},ready:function(a){(a===!0?--n.readyWait:n.isReady)||(n.isReady=!0,a!==!0&&--n.readyWait>0||(I.resolveWith(d,[n]),n.fn.triggerHandler&&(n(d).triggerHandler("ready"),n(d).off("ready"))))}});function J(){d.removeEventListener("DOMContentLoaded",J),a.removeEventListener("load",J),n.ready()}n.ready.promise=function(b){return I||(I=n.Deferred(),"complete"===d.readyState||"loading"!==d.readyState&&!d.documentElement.doScroll?a.setTimeout(n.ready):(d.addEventListener("DOMContentLoaded",J),a.addEventListener("load",J))),I.promise(b)},n.ready.promise();var K=function(a,b,c,d,e,f,g){var h=0,i=a.length,j=null==c;if("object"===n.type(c)){e=!0;for(h in c)K(a,b,h,c[h],!0,f,g)}else if(void 0!==d&&(e=!0,n.isFunction(d)||(g=!0),j&&(g?(b.call(a,d),b=null):(j=b,b=function(a,b,c){return j.call(n(a),c)})),b))for(;i>h;h++)b(a[h],c,g?d:d.call(a[h],h,b(a[h],c)));return e?a:j?b.call(a):i?b(a[0],c):f},L=function(a){return 1===a.nodeType||9===a.nodeType||!+a.nodeType};function M(){this.expando=n.expando+M.uid++}M.uid=1,M.prototype={register:function(a,b){var c=b||{};return a.nodeType?a[this.expando]=c:Object.defineProperty(a,this.expando,{value:c,writable:!0,configurable:!0}),a[this.expando]},cache:function(a){if(!L(a))return{};var b=a[this.expando];return b||(b={},L(a)&&(a.nodeType?a[this.expando]=b:Object.defineProperty(a,this.expando,{value:b,configurable:!0}))),b},set:function(a,b,c){var d,e=this.cache(a);if("string"==typeof b)e[b]=c;else for(d in b)e[d]=b[d];return e},get:function(a,b){return void 0===b?this.cache(a):a[this.expando]&&a[this.expando][b]},access:function(a,b,c){var d;return void 0===b||b&&"string"==typeof b&&void 0===c?(d=this.get(a,b),void 0!==d?d:this.get(a,n.camelCase(b))):(this.set(a,b,c),void 0!==c?c:b)},remove:function(a,b){var c,d,e,f=a[this.expando];if(void 0!==f){if(void 0===b)this.register(a);else{n.isArray(b)?d=b.concat(b.map(n.camelCase)):(e=n.camelCase(b),b in f?d=[b,e]:(d=e,d=d in f?[d]:d.match(G)||[])),c=d.length;while(c--)delete f[d[c]]}(void 0===b||n.isEmptyObject(f))&&(a.nodeType?a[this.expando]=void 0:delete a[this.expando])}},hasData:function(a){var b=a[this.expando];return void 0!==b&&!n.isEmptyObject(b)}};var N=new M,O=new M,P=/^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,Q=/[A-Z]/g;function R(a,b,c){var d;if(void 0===c&&1===a.nodeType)if(d="data-"+b.replace(Q,"-$&").toLowerCase(),c=a.getAttribute(d),"string"==typeof c){try{c="true"===c?!0:"false"===c?!1:"null"===c?null:+c+""===c?+c:P.test(c)?n.parseJSON(c):c}catch(e){}O.set(a,b,c); +}else c=void 0;return c}n.extend({hasData:function(a){return O.hasData(a)||N.hasData(a)},data:function(a,b,c){return O.access(a,b,c)},removeData:function(a,b){O.remove(a,b)},_data:function(a,b,c){return N.access(a,b,c)},_removeData:function(a,b){N.remove(a,b)}}),n.fn.extend({data:function(a,b){var c,d,e,f=this[0],g=f&&f.attributes;if(void 0===a){if(this.length&&(e=O.get(f),1===f.nodeType&&!N.get(f,"hasDataAttrs"))){c=g.length;while(c--)g[c]&&(d=g[c].name,0===d.indexOf("data-")&&(d=n.camelCase(d.slice(5)),R(f,d,e[d])));N.set(f,"hasDataAttrs",!0)}return e}return"object"==typeof a?this.each(function(){O.set(this,a)}):K(this,function(b){var c,d;if(f&&void 0===b){if(c=O.get(f,a)||O.get(f,a.replace(Q,"-$&").toLowerCase()),void 0!==c)return c;if(d=n.camelCase(a),c=O.get(f,d),void 0!==c)return c;if(c=R(f,d,void 0),void 0!==c)return c}else d=n.camelCase(a),this.each(function(){var c=O.get(this,d);O.set(this,d,b),a.indexOf("-")>-1&&void 0!==c&&O.set(this,a,b)})},null,b,arguments.length>1,null,!0)},removeData:function(a){return this.each(function(){O.remove(this,a)})}}),n.extend({queue:function(a,b,c){var d;return a?(b=(b||"fx")+"queue",d=N.get(a,b),c&&(!d||n.isArray(c)?d=N.access(a,b,n.makeArray(c)):d.push(c)),d||[]):void 0},dequeue:function(a,b){b=b||"fx";var c=n.queue(a,b),d=c.length,e=c.shift(),f=n._queueHooks(a,b),g=function(){n.dequeue(a,b)};"inprogress"===e&&(e=c.shift(),d--),e&&("fx"===b&&c.unshift("inprogress"),delete f.stop,e.call(a,g,f)),!d&&f&&f.empty.fire()},_queueHooks:function(a,b){var c=b+"queueHooks";return N.get(a,c)||N.access(a,c,{empty:n.Callbacks("once memory").add(function(){N.remove(a,[b+"queue",c])})})}}),n.fn.extend({queue:function(a,b){var c=2;return"string"!=typeof a&&(b=a,a="fx",c--),arguments.length",""],thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};$.optgroup=$.option,$.tbody=$.tfoot=$.colgroup=$.caption=$.thead,$.th=$.td;function _(a,b){var c="undefined"!=typeof a.getElementsByTagName?a.getElementsByTagName(b||"*"):"undefined"!=typeof a.querySelectorAll?a.querySelectorAll(b||"*"):[];return void 0===b||b&&n.nodeName(a,b)?n.merge([a],c):c}function aa(a,b){for(var c=0,d=a.length;d>c;c++)N.set(a[c],"globalEval",!b||N.get(b[c],"globalEval"))}var ba=/<|&#?\w+;/;function ca(a,b,c,d,e){for(var f,g,h,i,j,k,l=b.createDocumentFragment(),m=[],o=0,p=a.length;p>o;o++)if(f=a[o],f||0===f)if("object"===n.type(f))n.merge(m,f.nodeType?[f]:f);else if(ba.test(f)){g=g||l.appendChild(b.createElement("div")),h=(Y.exec(f)||["",""])[1].toLowerCase(),i=$[h]||$._default,g.innerHTML=i[1]+n.htmlPrefilter(f)+i[2],k=i[0];while(k--)g=g.lastChild;n.merge(m,g.childNodes),g=l.firstChild,g.textContent=""}else m.push(b.createTextNode(f));l.textContent="",o=0;while(f=m[o++])if(d&&n.inArray(f,d)>-1)e&&e.push(f);else if(j=n.contains(f.ownerDocument,f),g=_(l.appendChild(f),"script"),j&&aa(g),c){k=0;while(f=g[k++])Z.test(f.type||"")&&c.push(f)}return l}!function(){var a=d.createDocumentFragment(),b=a.appendChild(d.createElement("div")),c=d.createElement("input");c.setAttribute("type","radio"),c.setAttribute("checked","checked"),c.setAttribute("name","t"),b.appendChild(c),l.checkClone=b.cloneNode(!0).cloneNode(!0).lastChild.checked,b.innerHTML="",l.noCloneChecked=!!b.cloneNode(!0).lastChild.defaultValue}();var da=/^key/,ea=/^(?:mouse|pointer|contextmenu|drag|drop)|click/,fa=/^([^.]*)(?:\.(.+)|)/;function ga(){return!0}function ha(){return!1}function ia(){try{return d.activeElement}catch(a){}}function ja(a,b,c,d,e,f){var g,h;if("object"==typeof b){"string"!=typeof c&&(d=d||c,c=void 0);for(h in b)ja(a,h,c,d,b[h],f);return a}if(null==d&&null==e?(e=c,d=c=void 0):null==e&&("string"==typeof c?(e=d,d=void 0):(e=d,d=c,c=void 0)),e===!1)e=ha;else if(!e)return a;return 1===f&&(g=e,e=function(a){return n().off(a),g.apply(this,arguments)},e.guid=g.guid||(g.guid=n.guid++)),a.each(function(){n.event.add(this,b,e,d,c)})}n.event={global:{},add:function(a,b,c,d,e){var f,g,h,i,j,k,l,m,o,p,q,r=N.get(a);if(r){c.handler&&(f=c,c=f.handler,e=f.selector),c.guid||(c.guid=n.guid++),(i=r.events)||(i=r.events={}),(g=r.handle)||(g=r.handle=function(b){return"undefined"!=typeof n&&n.event.triggered!==b.type?n.event.dispatch.apply(a,arguments):void 0}),b=(b||"").match(G)||[""],j=b.length;while(j--)h=fa.exec(b[j])||[],o=q=h[1],p=(h[2]||"").split(".").sort(),o&&(l=n.event.special[o]||{},o=(e?l.delegateType:l.bindType)||o,l=n.event.special[o]||{},k=n.extend({type:o,origType:q,data:d,handler:c,guid:c.guid,selector:e,needsContext:e&&n.expr.match.needsContext.test(e),namespace:p.join(".")},f),(m=i[o])||(m=i[o]=[],m.delegateCount=0,l.setup&&l.setup.call(a,d,p,g)!==!1||a.addEventListener&&a.addEventListener(o,g)),l.add&&(l.add.call(a,k),k.handler.guid||(k.handler.guid=c.guid)),e?m.splice(m.delegateCount++,0,k):m.push(k),n.event.global[o]=!0)}},remove:function(a,b,c,d,e){var f,g,h,i,j,k,l,m,o,p,q,r=N.hasData(a)&&N.get(a);if(r&&(i=r.events)){b=(b||"").match(G)||[""],j=b.length;while(j--)if(h=fa.exec(b[j])||[],o=q=h[1],p=(h[2]||"").split(".").sort(),o){l=n.event.special[o]||{},o=(d?l.delegateType:l.bindType)||o,m=i[o]||[],h=h[2]&&new RegExp("(^|\\.)"+p.join("\\.(?:.*\\.|)")+"(\\.|$)"),g=f=m.length;while(f--)k=m[f],!e&&q!==k.origType||c&&c.guid!==k.guid||h&&!h.test(k.namespace)||d&&d!==k.selector&&("**"!==d||!k.selector)||(m.splice(f,1),k.selector&&m.delegateCount--,l.remove&&l.remove.call(a,k));g&&!m.length&&(l.teardown&&l.teardown.call(a,p,r.handle)!==!1||n.removeEvent(a,o,r.handle),delete i[o])}else for(o in i)n.event.remove(a,o+b[j],c,d,!0);n.isEmptyObject(i)&&N.remove(a,"handle events")}},dispatch:function(a){a=n.event.fix(a);var b,c,d,f,g,h=[],i=e.call(arguments),j=(N.get(this,"events")||{})[a.type]||[],k=n.event.special[a.type]||{};if(i[0]=a,a.delegateTarget=this,!k.preDispatch||k.preDispatch.call(this,a)!==!1){h=n.event.handlers.call(this,a,j),b=0;while((f=h[b++])&&!a.isPropagationStopped()){a.currentTarget=f.elem,c=0;while((g=f.handlers[c++])&&!a.isImmediatePropagationStopped())(!a.rnamespace||a.rnamespace.test(g.namespace))&&(a.handleObj=g,a.data=g.data,d=((n.event.special[g.origType]||{}).handle||g.handler).apply(f.elem,i),void 0!==d&&(a.result=d)===!1&&(a.preventDefault(),a.stopPropagation()))}return k.postDispatch&&k.postDispatch.call(this,a),a.result}},handlers:function(a,b){var c,d,e,f,g=[],h=b.delegateCount,i=a.target;if(h&&i.nodeType&&("click"!==a.type||isNaN(a.button)||a.button<1))for(;i!==this;i=i.parentNode||this)if(1===i.nodeType&&(i.disabled!==!0||"click"!==a.type)){for(d=[],c=0;h>c;c++)f=b[c],e=f.selector+" ",void 0===d[e]&&(d[e]=f.needsContext?n(e,this).index(i)>-1:n.find(e,this,null,[i]).length),d[e]&&d.push(f);d.length&&g.push({elem:i,handlers:d})}return h]*)\/>/gi,la=/\s*$/g;function pa(a,b){return n.nodeName(a,"table")&&n.nodeName(11!==b.nodeType?b:b.firstChild,"tr")?a.getElementsByTagName("tbody")[0]||a.appendChild(a.ownerDocument.createElement("tbody")):a}function qa(a){return a.type=(null!==a.getAttribute("type"))+"/"+a.type,a}function ra(a){var b=na.exec(a.type);return b?a.type=b[1]:a.removeAttribute("type"),a}function sa(a,b){var c,d,e,f,g,h,i,j;if(1===b.nodeType){if(N.hasData(a)&&(f=N.access(a),g=N.set(b,f),j=f.events)){delete g.handle,g.events={};for(e in j)for(c=0,d=j[e].length;d>c;c++)n.event.add(b,e,j[e][c])}O.hasData(a)&&(h=O.access(a),i=n.extend({},h),O.set(b,i))}}function ta(a,b){var c=b.nodeName.toLowerCase();"input"===c&&X.test(a.type)?b.checked=a.checked:("input"===c||"textarea"===c)&&(b.defaultValue=a.defaultValue)}function ua(a,b,c,d){b=f.apply([],b);var e,g,h,i,j,k,m=0,o=a.length,p=o-1,q=b[0],r=n.isFunction(q);if(r||o>1&&"string"==typeof q&&!l.checkClone&&ma.test(q))return a.each(function(e){var f=a.eq(e);r&&(b[0]=q.call(this,e,f.html())),ua(f,b,c,d)});if(o&&(e=ca(b,a[0].ownerDocument,!1,a,d),g=e.firstChild,1===e.childNodes.length&&(e=g),g||d)){for(h=n.map(_(e,"script"),qa),i=h.length;o>m;m++)j=e,m!==p&&(j=n.clone(j,!0,!0),i&&n.merge(h,_(j,"script"))),c.call(a[m],j,m);if(i)for(k=h[h.length-1].ownerDocument,n.map(h,ra),m=0;i>m;m++)j=h[m],Z.test(j.type||"")&&!N.access(j,"globalEval")&&n.contains(k,j)&&(j.src?n._evalUrl&&n._evalUrl(j.src):n.globalEval(j.textContent.replace(oa,"")))}return a}function va(a,b,c){for(var d,e=b?n.filter(b,a):a,f=0;null!=(d=e[f]);f++)c||1!==d.nodeType||n.cleanData(_(d)),d.parentNode&&(c&&n.contains(d.ownerDocument,d)&&aa(_(d,"script")),d.parentNode.removeChild(d));return a}n.extend({htmlPrefilter:function(a){return a.replace(ka,"<$1>")},clone:function(a,b,c){var d,e,f,g,h=a.cloneNode(!0),i=n.contains(a.ownerDocument,a);if(!(l.noCloneChecked||1!==a.nodeType&&11!==a.nodeType||n.isXMLDoc(a)))for(g=_(h),f=_(a),d=0,e=f.length;e>d;d++)ta(f[d],g[d]);if(b)if(c)for(f=f||_(a),g=g||_(h),d=0,e=f.length;e>d;d++)sa(f[d],g[d]);else sa(a,h);return g=_(h,"script"),g.length>0&&aa(g,!i&&_(a,"script")),h},cleanData:function(a){for(var b,c,d,e=n.event.special,f=0;void 0!==(c=a[f]);f++)if(L(c)){if(b=c[N.expando]){if(b.events)for(d in b.events)e[d]?n.event.remove(c,d):n.removeEvent(c,d,b.handle);c[N.expando]=void 0}c[O.expando]&&(c[O.expando]=void 0)}}}),n.fn.extend({domManip:ua,detach:function(a){return va(this,a,!0)},remove:function(a){return va(this,a)},text:function(a){return K(this,function(a){return void 0===a?n.text(this):this.empty().each(function(){(1===this.nodeType||11===this.nodeType||9===this.nodeType)&&(this.textContent=a)})},null,a,arguments.length)},append:function(){return ua(this,arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=pa(this,a);b.appendChild(a)}})},prepend:function(){return ua(this,arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=pa(this,a);b.insertBefore(a,b.firstChild)}})},before:function(){return ua(this,arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this)})},after:function(){return ua(this,arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this.nextSibling)})},empty:function(){for(var a,b=0;null!=(a=this[b]);b++)1===a.nodeType&&(n.cleanData(_(a,!1)),a.textContent="");return this},clone:function(a,b){return a=null==a?!1:a,b=null==b?a:b,this.map(function(){return n.clone(this,a,b)})},html:function(a){return K(this,function(a){var b=this[0]||{},c=0,d=this.length;if(void 0===a&&1===b.nodeType)return b.innerHTML;if("string"==typeof a&&!la.test(a)&&!$[(Y.exec(a)||["",""])[1].toLowerCase()]){a=n.htmlPrefilter(a);try{for(;d>c;c++)b=this[c]||{},1===b.nodeType&&(n.cleanData(_(b,!1)),b.innerHTML=a);b=0}catch(e){}}b&&this.empty().append(a)},null,a,arguments.length)},replaceWith:function(){var a=[];return ua(this,arguments,function(b){var c=this.parentNode;n.inArray(this,a)<0&&(n.cleanData(_(this)),c&&c.replaceChild(b,this))},a)}}),n.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){n.fn[a]=function(a){for(var c,d=[],e=n(a),f=e.length-1,h=0;f>=h;h++)c=h===f?this:this.clone(!0),n(e[h])[b](c),g.apply(d,c.get());return this.pushStack(d)}});var wa,xa={HTML:"block",BODY:"block"};function ya(a,b){var c=n(b.createElement(a)).appendTo(b.body),d=n.css(c[0],"display");return c.detach(),d}function za(a){var b=d,c=xa[a];return c||(c=ya(a,b),"none"!==c&&c||(wa=(wa||n("