- "kind": {
- "type": "string",
- "description": "This is always orvos#user.",
- "default": "orvos#user"
- },
- "picture": {
- "type": "object",
- "description": "The user's profile picture.",
- "properties": {
- "url": {
- "type": "string",
- "description": "A URL that points to a profile picture of this user."
- }
- }
- }
- }
- }
- },
- "resources": {
- "about": {
- "methods": {
- "get": {
- "id": "orvos.about.get",
- "path": "about",
- "httpMethod": "GET",
- "description": "Gets the information about the current user along with Orvos API settings",
- "parameters": {
- "includeSubscribed": {
- "type": "boolean",
- "description": "Whether to include subscribed items when calculating the number of remaining change IDs",
- "default": "true",
- "location": "query"
- },
- "maxChangeIdCount": {
- "type": "string",
- "description": "Maximum number of remaining change IDs to count",
- "default": "1",
- "format": "int64",
- "location": "query"
- },
- "startChangeId": {
- "type": "string",
- "description": "Change ID to start counting from when calculating number of remaining change IDs",
- "format": "int64",
- "location": "query"
- }
- },
- "response": {
- "$ref": "About"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.file",
- "https://api.clinicalfuture.com/auth/orvos.metadata.readonly",
- "https://api.clinicalfuture.com/auth/orvos.readonly"
- ]
- }
- }
- },
- "apps": {
- "methods": {
- "get": {
- "id": "orvos.apps.get",
- "path": "apps/{appId}",
- "httpMethod": "GET",
- "description": "Gets a specific app.",
- "parameters": {
- "appId": {
- "type": "string",
- "description": "The ID of the app.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "appId"
- ],
- "response": {
- "$ref": "App"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos.apps.readonly"
- ]
- },
- "list": {
- "id": "orvos.apps.list",
- "path": "apps",
- "httpMethod": "GET",
- "description": "Lists a user's apps.",
- "response": {
- "$ref": "AppList"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos.apps.readonly"
- ]
- }
- }
- },
- "changes": {
- "methods": {
- "get": {
- "id": "orvos.changes.get",
- "path": "changes/{changeId}",
- "httpMethod": "GET",
- "description": "Gets a specific change.",
- "parameters": {
- "changeId": {
- "type": "string",
- "description": "The ID of the change.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "changeId"
- ],
- "response": {
- "$ref": "Change"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.file",
- "https://api.clinicalfuture.com/auth/orvos.metadata.readonly",
- "https://api.clinicalfuture.com/auth/orvos.readonly"
- ]
- },
- "list": {
- "id": "orvos.changes.list",
- "path": "changes",
- "httpMethod": "GET",
- "description": "Lists the changes for a user.",
- "parameters": {
- "includeDeleted": {
- "type": "boolean",
- "description": "Whether to include deleted items.",
- "default": "true",
- "location": "query"
- },
- "includeSubscribed": {
- "type": "boolean",
- "description": "Whether to include subscribed items.",
- "default": "true",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of changes to return.",
- "default": "100",
- "format": "int32",
- "minimum": "0",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Page token for changes.",
- "location": "query"
- },
- "startChangeId": {
- "type": "string",
- "description": "Change ID to start listing changes from.",
- "format": "int64",
- "location": "query"
- }
- },
- "response": {
- "$ref": "ChangeList"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.file",
- "https://api.clinicalfuture.com/auth/orvos.metadata.readonly",
- "https://api.clinicalfuture.com/auth/orvos.readonly"
- ]
- }
- }
- },
- "children": {
- "methods": {
- "delete": {
- "id": "orvos.children.delete",
- "path": "files/{folderId}/children/{childId}",
- "httpMethod": "DELETE",
- "description": "Removes a child from a folder.",
- "parameters": {
- "childId": {
- "type": "string",
- "description": "The ID of the child.",
- "required": true,
- "location": "path"
- },
- "folderId": {
- "type": "string",
- "description": "The ID of the folder.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "folderId",
- "childId"
- ],
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.file"
- ]
- },
- "get": {
- "id": "orvos.children.get",
- "path": "files/{folderId}/children/{childId}",
- "httpMethod": "GET",
- "description": "Gets a specific child reference.",
- "parameters": {
- "childId": {
- "type": "string",
- "description": "The ID of the child.",
- "required": true,
- "location": "path"
- },
- "folderId": {
- "type": "string",
- "description": "The ID of the folder.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "folderId",
- "childId"
- ],
- "response": {
- "$ref": "ChildReference"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.file",
- "https://api.clinicalfuture.com/auth/orvos.metadata.readonly",
- "https://api.clinicalfuture.com/auth/orvos.readonly"
- ]
- },
- "insert": {
- "id": "orvos.children.insert",
- "path": "files/{folderId}/children",
- "httpMethod": "POST",
- "description": "Inserts a file into a folder.",
- "parameters": {
- "folderId": {
- "type": "string",
- "description": "The ID of the folder.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "folderId"
- ],
- "request": {
- "$ref": "ChildReference"
- },
- "response": {
- "$ref": "ChildReference"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.file"
- ]
- },
- "list": {
- "id": "orvos.children.list",
- "path": "files/{folderId}/children",
- "httpMethod": "GET",
- "description": "Lists a folder's children.",
- "parameters": {
- "folderId": {
- "type": "string",
- "description": "The ID of the folder.",
- "required": true,
- "location": "path"
- },
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of children to return.",
- "default": "100",
- "format": "int32",
- "minimum": "0",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Page token for children.",
- "location": "query"
- },
- "q": {
- "type": "string",
- "description": "Query string for searching children.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "folderId"
- ],
- "response": {
- "$ref": "ChildList"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.file",
- "https://api.clinicalfuture.com/auth/orvos.metadata.readonly",
- "https://api.clinicalfuture.com/auth/orvos.readonly"
- ]
- }
- }
- },
- "comments": {
- "methods": {
- "delete": {
- "id": "orvos.comments.delete",
- "path": "files/{fileId}/comments/{commentId}",
- "httpMethod": "DELETE",
- "description": "Deletes a comment.",
- "parameters": {
- "commentId": {
- "type": "string",
- "description": "The ID of the comment.",
- "required": true,
- "location": "path"
- },
- "fileId": {
- "type": "string",
- "description": "The ID of the file.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "fileId",
- "commentId"
- ],
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.readonly"
- ]
- },
- "get": {
- "id": "orvos.comments.get",
- "path": "files/{fileId}/comments/{commentId}",
- "httpMethod": "GET",
- "description": "Gets a comment by ID.",
- "parameters": {
- "commentId": {
- "type": "string",
- "description": "The ID of the comment.",
- "required": true,
- "location": "path"
- },
- "fileId": {
- "type": "string",
- "description": "The ID of the file.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "fileId",
- "commentId"
- ],
- "response": {
- "$ref": "Comment"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.readonly"
- ]
- },
- "insert": {
- "id": "orvos.comments.insert",
- "path": "files/{fileId}/comments",
- "httpMethod": "POST",
- "description": "Creates a new comment on the given file.",
- "parameters": {
- "fileId": {
- "type": "string",
- "description": "The ID of the file.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "fileId"
- ],
- "request": {
- "$ref": "Comment"
- },
- "response": {
- "$ref": "Comment"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.readonly"
- ]
- },
- "list": {
- "id": "orvos.comments.list",
- "path": "files/{fileId}/comments",
- "httpMethod": "GET",
- "description": "Lists a file's comments.",
- "parameters": {
- "fileId": {
- "type": "string",
- "description": "The ID of the file.",
- "required": true,
- "location": "path"
- },
- "includeDeleted": {
- "type": "boolean",
- "description": "If set, all comments, including deleted comments (with content stripped) will be returned.",
- "default": "false",
- "location": "query"
- },
- "maxResults": {
- "type": "integer",
- "description": "The maximum number of discussions to include in the response, used for paging.",
- "default": "20",
- "format": "int32",
- "minimum": "0",
- "maximum": "100",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of \"nextPageToken\" from the previous response.",
- "location": "query"
- },
- "updatedMin": {
- "type": "string",
- "description": "Only discussions that were updated after this timestamp will be returned. Formatted as an RFC 3339 timestamp.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "fileId"
- ],
- "response": {
- "$ref": "CommentList"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.readonly"
- ]
- },
- "patch": {
- "id": "orvos.comments.patch",
- "path": "files/{fileId}/comments/{commentId}",
- "httpMethod": "PATCH",
- "description": "Updates an existing comment. This method supports patch semantics.",
- "parameters": {
- "commentId": {
- "type": "string",
- "description": "The ID of the comment.",
- "required": true,
- "location": "path"
- },
- "fileId": {
- "type": "string",
- "description": "The ID of the file.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "fileId",
- "commentId"
- ],
- "request": {
- "$ref": "Comment"
- },
- "response": {
- "$ref": "Comment"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos"
- ]
- },
- "update": {
- "id": "orvos.comments.update",
- "path": "files/{fileId}/comments/{commentId}",
- "httpMethod": "PUT",
- "description": "Updates an existing comment.",
- "parameters": {
- "commentId": {
- "type": "string",
- "description": "The ID of the comment.",
- "required": true,
- "location": "path"
- },
- "fileId": {
- "type": "string",
- "description": "The ID of the file.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "fileId",
- "commentId"
- ],
- "request": {
- "$ref": "Comment"
- },
- "response": {
- "$ref": "Comment"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos"
- ]
- }
- }
- },
- "metadata": {
- "methods": {
- "create": {
- "id": "orvos.metadata.create",
- "path": "metadata",
- "httpMethod": "POST",
- "description": "Create a new metadata object.",
- "parameters": {
- "metadatum": {
- "required": true,
- "location": "query",
- "properties": {
- "metadata_class": {
- "type": "string",
- "description": "Metadata class.",
- "required": true
- },
- "key": {
- "type": "string",
- "description": "Metadata key.",
- "required": true
- },
- "value": {
- "type": "string",
- "description": "Metadata value.",
- "required": true
- }
- }
- }
- },
- "request": {
- "$ref": "Metadatum"
- },
- "response": {
- "$ref": "Metadatum"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.metadatum"
- ]
- },
- "list": {
- "id": "orvos.metadata.list",
- "path": "metadata",
- "httpMethod": "GET",
- "description": "Lists metadata objects.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of metadata objects to return.",
- "default": "100",
- "format": "int32",
- "minimum": "0",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Page token for metadata objects.",
- "location": "query"
- },
- "q": {
- "type": "string",
- "description": "Query string for searching metadata.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "MetadatumList"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.metadatum",
- "https://api.clinicalfuture.com/auth/orvos.metadatum.readonly",
- "https://api.clinicalfuture.com/auth/orvos.readonly"
- ]
- }
- }
- },
- "nodes": {
- "methods": {
- "create": {
- "id": "orvos.nodes.create",
- "path": "nodes",
- "httpMethod": "POST",
- "parameters": {
- }
- },
- "get": {
- "id": "orvos.nodes.get",
- "path": "nodes/{nodeId}",
- "httpMethod": "GET",
- "parameters": {
- "uuid": {
- "type": "string"
- }
- }
- }
- }
- },
- "collections": {
- "methods": {
- "copy": {
- "id": "orvos.collections.copy",
- "path": "collections/{collectionId}/copy",
- "httpMethod": "POST",
- "description": "Creates a copy of the specified collection.",
- "parameters": {
- "convert": {
- "type": "boolean",
- "description": "Whether to convert this collection to the corresponding Google Docs format.",
- "default": "false",
- "location": "query"
- },
- "collectionId": {
- "type": "string",
- "description": "The ID of the collection to copy.",
- "required": true,
- "location": "path"
- },
- "ocr": {
- "type": "boolean",
- "description": "Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.",
- "default": "false",
- "location": "query"
- },
- "ocrLanguage": {
- "type": "string",
- "description": "If ocr is true, hints at the language to use. Valid values are ISO 639-1 codes.",
- "location": "query"
- },
- "pinned": {
- "type": "boolean",
- "description": "Whether to pin the head revision of the new copy.",
- "default": "false",
- "location": "query"
- },
- "sourceLanguage": {
- "type": "string",
- "description": "The language of the original collection to be translated.",
- "location": "query"
- },
- "targetLanguage": {
- "type": "string",
- "description": "Target language to translate the collection to. If no sourceLanguage is provided, the API will attempt to detect the language.",
- "location": "query"
- },
- "timedTextLanguage": {
- "type": "string",
- "description": "The language of the timed text.",
- "location": "query"
- },
- "timedTextTrackName": {
- "type": "string",
- "description": "The timed text track name.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "collectionId"
- ],
- "request": {
- "$ref": "Collection"
- },
- "response": {
- "$ref": "Collection"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.collection"
- ]
- },
- "delete": {
- "id": "orvos.collections.delete",
- "path": "collections/{collectionId}",
- "httpMethod": "DELETE",
- "description": "Permanently deletes a collection by ID. Skips the trash.",
- "parameters": {
- "collectionId": {
- "type": "string",
- "description": "The ID of the collection to delete.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "collectionId"
- ],
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.collection"
- ]
- },
- "get": {
- "id": "orvos.collections.get",
- "path": "collections/{collectionId}",
- "httpMethod": "GET",
- "description": "Gets a collection's metadata by ID.",
- "parameters": {
- "collectionId": {
- "type": "string",
- "description": "The ID for the collection in question.",
- "required": true,
- "location": "path"
- },
- "projection": {
- "type": "string",
- "description": "This parameter is deprecated and has no function.",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "enumDescriptions": [
- "Deprecated",
- "Deprecated"
- ],
- "location": "query"
- },
- "updateViewedDate": {
- "type": "boolean",
- "description": "Whether to update the view date after successfully retrieving the collection.",
- "default": "false",
- "location": "query"
- }
- },
- "parameterOrder": [
- "collectionId"
- ],
- "response": {
- "$ref": "Collection"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.collection",
- "https://api.clinicalfuture.com/auth/orvos.metadata.readonly",
- "https://api.clinicalfuture.com/auth/orvos.readonly"
- ]
- },
- "create": {
- "id": "orvos.collections.create",
- "path": "collections",
- "httpMethod": "POST",
- "description": "Create a new collection.",
- "parameters": {
- "collection": {
- "type": "object",
- "description": "New collection attributes.",
- "properties": {
- "locator": {
- "type": "string",
- "description": "CAS locator.",
- "location": "query",
- "required": true
- },
- "name": {
- "type": "string",
- "description": "Name.",
- "location": "query",
- "required": true
- }
- }
- }
- },
- "request": {
- "$ref": "Collection"
- },
- "response": {
- "$ref": "Collection"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.collection"
- ],
- "supportsMediaUpload": true,
- "mediaUpload": {
- "accept": [
- "*/*"
- ],
- "maxSize": "10GB",
- "protocols": {
- "simple": {
- "multipart": true,
- "path": "/upload/orvos/v2/collections"
- },
- "resumable": {
- "multipart": true,
- "path": "/resumable/upload/orvos/v2/collections"
- }
- }
- }
- },
- "list": {
- "id": "orvos.collections.list",
- "path": "collections",
- "httpMethod": "GET",
- "description": "Lists the user's collections.",
- "parameters": {
- "maxResults": {
- "type": "integer",
- "description": "Maximum number of collections to return.",
- "default": "100",
- "format": "int32",
- "minimum": "0",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Page token for collections.",
- "location": "query"
- },
- "projection": {
- "type": "string",
- "description": "This parameter is deprecated and has no function.",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "enumDescriptions": [
- "Deprecated",
- "Deprecated"
- ],
- "location": "query"
- },
- "q": {
- "type": "string",
- "description": "Query string for searching collections.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "CollectionList"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.collection",
- "https://api.clinicalfuture.com/auth/orvos.metadata.readonly",
- "https://api.clinicalfuture.com/auth/orvos.readonly"
- ]
- },
- "patch": {
- "id": "orvos.collections.patch",
- "path": "collections/{collectionId}",
- "httpMethod": "PATCH",
- "description": "Updates collection metadata and/or content. This method supports patch semantics.",
- "parameters": {
- "convert": {
- "type": "boolean",
- "description": "Whether to convert this collection to the corresponding Google Docs format.",
- "default": "false",
- "location": "query"
- },
- "collectionId": {
- "type": "string",
- "description": "The ID of the collection to update.",
- "required": true,
- "location": "path"
- },
- "newRevision": {
- "type": "boolean",
- "description": "Whether a blob upload should create a new revision. If false, the blob data in the current head revision will be replaced.",
- "default": "true",
- "location": "query"
- },
- "ocr": {
- "type": "boolean",
- "description": "Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.",
- "default": "false",
- "location": "query"
- },
- "ocrLanguage": {
- "type": "string",
- "description": "If ocr is true, hints at the language to use. Valid values are ISO 639-1 codes.",
- "location": "query"
- },
- "pinned": {
- "type": "boolean",
- "description": "Whether to pin the new revision.",
- "default": "false",
- "location": "query"
- },
- "setModifiedDate": {
- "type": "boolean",
- "description": "Whether to set the modified date with the supplied modified date.",
- "default": "false",
- "location": "query"
- },
- "sourceLanguage": {
- "type": "string",
- "description": "The language of the original collection to be translated.",
- "location": "query"
- },
- "targetLanguage": {
- "type": "string",
- "description": "Target language to translate the collection to. If no sourceLanguage is provided, the API will attempt to detect the language.",
- "location": "query"
- },
- "timedTextLanguage": {
- "type": "string",
- "description": "The language of the timed text.",
- "location": "query"
- },
- "timedTextTrackName": {
- "type": "string",
- "description": "The timed text track name.",
- "location": "query"
- },
- "updateViewedDate": {
- "type": "boolean",
- "description": "Whether to update the view date after successfully updating the collection.",
- "default": "true",
- "location": "query"
- }
- },
- "parameterOrder": [
- "collectionId"
- ],
- "request": {
- "$ref": "Collection"
- },
- "response": {
- "$ref": "Collection"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.collection"
- ]
- },
- "touch": {
- "id": "orvos.collections.touch",
- "path": "collections/{collectionId}/touch",
- "httpMethod": "POST",
- "description": "Set the collection's updated time to the current server time.",
- "parameters": {
- "collectionId": {
- "type": "string",
- "description": "The ID of the collection to update.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "collectionId"
- ],
- "response": {
- "$ref": "Collection"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.collection"
- ]
- },
- "trash": {
- "id": "orvos.collections.trash",
- "path": "collections/{collectionId}/trash",
- "httpMethod": "POST",
- "description": "Moves a collection to the trash.",
- "parameters": {
- "collectionId": {
- "type": "string",
- "description": "The ID of the collection to trash.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "collectionId"
- ],
- "response": {
- "$ref": "Collection"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.collection"
- ]
- },
- "untrash": {
- "id": "orvos.collections.untrash",
- "path": "collections/{collectionId}/untrash",
- "httpMethod": "POST",
- "description": "Restores a collection from the trash.",
- "parameters": {
- "collectionId": {
- "type": "string",
- "description": "The ID of the collection to untrash.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "collectionId"
- ],
- "response": {
- "$ref": "Collection"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.collection"
- ]
- },
- "update": {
- "id": "orvos.collections.update",
- "path": "collections/{collectionId}",
- "httpMethod": "PUT",
- "description": "Updates collection metadata and/or content",
- "parameters": {
- "convert": {
- "type": "boolean",
- "description": "Whether to convert this collection to the corresponding Google Docs format.",
- "default": "false",
- "location": "query"
- },
- "collectionId": {
- "type": "string",
- "description": "The ID of the collection to update.",
- "required": true,
- "location": "path"
- },
- "newRevision": {
- "type": "boolean",
- "description": "Whether a blob upload should create a new revision. If false, the blob data in the current head revision will be replaced.",
- "default": "true",
- "location": "query"
- },
- "ocr": {
- "type": "boolean",
- "description": "Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.",
- "default": "false",
- "location": "query"
- },
- "ocrLanguage": {
- "type": "string",
- "description": "If ocr is true, hints at the language to use. Valid values are ISO 639-1 codes.",
- "location": "query"
- },
- "pinned": {
- "type": "boolean",
- "description": "Whether to pin the new revision.",
- "default": "false",
- "location": "query"
- },
- "setModifiedDate": {
- "type": "boolean",
- "description": "Whether to set the modified date with the supplied modified date.",
- "default": "false",
- "location": "query"
- },
- "sourceLanguage": {
- "type": "string",
- "description": "The language of the original collection to be translated.",
- "location": "query"
- },
- "targetLanguage": {
- "type": "string",
- "description": "Target language to translate the collection to. If no sourceLanguage is provided, the API will attempt to detect the language.",
- "location": "query"
- },
- "timedTextLanguage": {
- "type": "string",
- "description": "The language of the timed text.",
- "location": "query"
- },
- "timedTextTrackName": {
- "type": "string",
- "description": "The timed text track name.",
- "location": "query"
- },
- "updateViewedDate": {
- "type": "boolean",
- "description": "Whether to update the view date after successfully updating the collection.",
- "default": "true",
- "location": "query"
- }
- },
- "parameterOrder": [
- "collectionId"
- ],
- "request": {
- "$ref": "Collection"
- },
- "response": {
- "$ref": "Collection"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.collection"
- ],
- "supportsMediaUpload": true,
- "mediaUpload": {
- "accept": [
- "*/*"
- ],
- "maxSize": "10GB",
- "protocols": {
- "simple": {
- "multipart": true,
- "path": "/upload/orvos/v2/collections/{collectionId}"
- },
- "resumable": {
- "multipart": true,
- "path": "/resumable/upload/orvos/v2/collections/{collectionId}"
- }
- }
- }
- }
- }
- },
- "parents": {
- "methods": {
- "delete": {
- "id": "orvos.parents.delete",
- "path": "files/{fileId}/parents/{parentId}",
- "httpMethod": "DELETE",
- "description": "Removes a parent from a file.",
- "parameters": {
- "fileId": {
- "type": "string",
- "description": "The ID of the file.",
- "required": true,
- "location": "path"
- },
- "parentId": {
- "type": "string",
- "description": "The ID of the parent.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "fileId",
- "parentId"
- ],
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.file"
- ]
- },
- "get": {
- "id": "orvos.parents.get",
- "path": "files/{fileId}/parents/{parentId}",
- "httpMethod": "GET",
- "description": "Gets a specific parent reference.",
- "parameters": {
- "fileId": {
- "type": "string",
- "description": "The ID of the file.",
- "required": true,
- "location": "path"
- },
- "parentId": {
- "type": "string",
- "description": "The ID of the parent.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "fileId",
- "parentId"
- ],
- "response": {
- "$ref": "ParentReference"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.file",
- "https://api.clinicalfuture.com/auth/orvos.metadata.readonly",
- "https://api.clinicalfuture.com/auth/orvos.readonly"
- ]
- },
- "insert": {
- "id": "orvos.parents.insert",
- "path": "files/{fileId}/parents",
- "httpMethod": "POST",
- "description": "Adds a parent folder for a file.",
- "parameters": {
- "fileId": {
- "type": "string",
- "description": "The ID of the file.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "fileId"
- ],
- "request": {
- "$ref": "ParentReference"
- },
- "response": {
- "$ref": "ParentReference"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.file"
- ]
- },
- "list": {
- "id": "orvos.parents.list",
- "path": "files/{fileId}/parents",
- "httpMethod": "GET",
- "description": "Lists a file's parents.",
- "parameters": {
- "fileId": {
- "type": "string",
- "description": "The ID of the file.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "fileId"
- ],
- "response": {
- "$ref": "ParentList"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.file",
- "https://api.clinicalfuture.com/auth/orvos.metadata.readonly",
- "https://api.clinicalfuture.com/auth/orvos.readonly"
- ]
- }
- }
- },
- "permissions": {
- "methods": {
- "delete": {
- "id": "orvos.permissions.delete",
- "path": "files/{fileId}/permissions/{permissionId}",
- "httpMethod": "DELETE",
- "description": "Deletes a permission from a file.",
- "parameters": {
- "fileId": {
- "type": "string",
- "description": "The ID for the file.",
- "required": true,
- "location": "path"
- },
- "permissionId": {
- "type": "string",
- "description": "The ID for the permission.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "fileId",
- "permissionId"
- ],
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.file"
- ]
- },
- "get": {
- "id": "orvos.permissions.get",
- "path": "files/{fileId}/permissions/{permissionId}",
- "httpMethod": "GET",
- "description": "Gets a permission by ID.",
- "parameters": {
- "fileId": {
- "type": "string",
- "description": "The ID for the file.",
- "required": true,
- "location": "path"
- },
- "permissionId": {
- "type": "string",
- "description": "The ID for the permission.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "fileId",
- "permissionId"
- ],
- "response": {
- "$ref": "Permission"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.file",
- "https://api.clinicalfuture.com/auth/orvos.metadata.readonly",
- "https://api.clinicalfuture.com/auth/orvos.readonly"
- ]
- },
- "insert": {
- "id": "orvos.permissions.insert",
- "path": "files/{fileId}/permissions",
- "httpMethod": "POST",
- "description": "Inserts a permission for a file.",
- "parameters": {
- "fileId": {
- "type": "string",
- "description": "The ID for the file.",
- "required": true,
- "location": "path"
- },
- "sendNotificationEmails": {
- "type": "boolean",
- "description": "Whether to send notification emails.",
- "default": "true",
- "location": "query"
- }
- },
- "parameterOrder": [
- "fileId"
- ],
- "request": {
- "$ref": "Permission"
- },
- "response": {
- "$ref": "Permission"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.file"
- ]
- },
- "list": {
- "id": "orvos.permissions.list",
- "path": "files/{fileId}/permissions",
- "httpMethod": "GET",
- "description": "Lists a file's permissions.",
- "parameters": {
- "fileId": {
- "type": "string",
- "description": "The ID for the file.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "fileId"
- ],
- "response": {
- "$ref": "PermissionList"
- },
- "scopes": [
- "https://api.clinicalfuture.com/auth/orvos",
- "https://api.clinicalfuture.com/auth/orvos.file",
- "https://api.clinicalfuture.com/auth/orvos.metadata.readonly",
- "https://api.clinicalfuture.com/auth/orvos.readonly"
- ]
- },
- "patch": {
- "id": "orvos.permissions.patch",
- "path": "files/{fileId}/permissions/{permissionId}",
- "httpMethod": "PATCH",
- "description": "Updates a permission. This method supports patch semantics.",