v1

latestOpenAPI 3.0.12026-07-17311136.1 KB

contents

Get contents of file or directory

A client can optionally specify a type and/or format argument via URL parameter. When given, the Contents service shall return a model in the requested type and/or format. If the request cannot be satisfied, e.g. type=text is requested, but the file is binary, then the request shall fail with 400 and have a JSON response containing a 'reason' field, with the value 'bad format' or 'bad type', depending on what was requested.

get/api/contents/{path}

Path parameters

pathstring required

file path

Query parameters

type'file' | 'directory'

File type ('file', 'directory')

format'text' | 'base64'

How file content should be returned ('text', 'base64')

contentinteger

Return content (0 for no content, 1 for return content)

hashinteger

May return hash hexdigest string of content and the hash algorithm (0 for no hash - default, 1 for return hash). It may be ignored by the content manager.

Response

Contents of file or directory

namestring required

Name of file or directory, equivalent to the last part of the path

pathstring required

Full path for file or directory

type'directory' | 'file' | 'notebook' required

Type of content

writableboolean required

indicates whether the requester has permission to edit the file

createdstring dateTime required

Creation timestamp

last_modifiedstring dateTime required

Last modified timestamp

sizeinteger

The size of the file or notebook in bytes. If no size is provided, defaults to null.

mimetypestring required

The mimetype of a file. If content is not null, and type is 'file', this will contain the mimetype of the file, otherwise this will be null.

formatstring required

Format of content (one of null, 'text', 'base64', 'json')

hashstring

[optional] The hexdigest hash string of content, if requested (otherwise null). It cannot be null if hash_algorithm is defined.

hash_algorithmstring

[optional] The algorithm used to produce the hash, if requested (otherwise null). It cannot be null if hash is defined.