logo
API docs by Redocly

Finmars API (v1)

Download OpenAPI specification:

E-mail: admin@finmars.com License: BSD License Terms of Service

Finmars Documentation

Copy

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
target_directory_path
required
string (Target directory path) non-empty
paths
required
Array of strings[ items non-empty ]

Responses

Request samples

Content type
application/json
{
  • "target_directory_path": "string",
  • "paths": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "task_id": "string"
}

Create Folder

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
path
required
string (Path) non-empty

Responses

Request samples

Content type
application/json
{
  • "path": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "path": "string",
  • "details": "string",
  • "files": [
    ],
  • "results": [
    ]
}

Delete Folder

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
path
required
string (Path) non-empty
is_dir
string or null (Is dir) non-empty
Default: "false"

Responses

Request samples

Content type
application/json
{
  • "path": "string",
  • "is_dir": "false"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "path": "string",
  • "details": "string",
  • "files": [
    ],
  • "results": [
    ]
}

Delete

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
path
required
string (Path) non-empty
is_dir
string or null (Is dir) non-empty
Default: "false"

Responses

Request samples

Content type
application/json
{
  • "path": "string",
  • "is_dir": "false"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "path": "string",
  • "details": "string",
  • "files": [
    ],
  • "results": [
    ]
}

Download As Zip

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
paths
required
Array of strings[ items non-empty ]

Responses

Request samples

Content type
application/json
{
  • "paths": [
    ]
}

Response samples

Content type
application/json
"string"

Download

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
path
required
string (Path) non-empty

Responses

Request samples

Content type
application/json
{
  • "path": "string"
}

Response samples

Content type
application/json
"string"

Explorer

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
path
string
Default: "/"
page
integer
Default: 1
page_size
integer
Default: 40

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "path": "string",
  • "details": "string",
  • "files": [
    ],
  • "results": [
    ]
}

Move

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
target_directory_path
required
string (Target directory path) non-empty
paths
required
Array of strings[ items non-empty ]

Responses

Request samples

Content type
application/json
{
  • "target_directory_path": "string",
  • "paths": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "task_id": "string"
}

Rename

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
path
required
string (Path) non-empty
new_name
required
string (New name) non-empty

Responses

Request samples

Content type
application/json
{
  • "path": "string",
  • "new_name": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "task_id": "string"
}

Search

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

query
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this storage object.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "path": "string",
  • "size": 9223372036854776000,
  • "is_file": true,
  • "resource_groups": [
    ],
  • "lft": 0,
  • "rght": 0,
  • "tree_id": 0,
  • "mptt_level": 0,
  • "parent": 0
}

Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this storage object.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "path": "string",
  • "size": 9223372036854776000,
  • "is_file": true,
  • "resource_groups": [
    ],
  • "lft": 0,
  • "rght": 0,
  • "tree_id": 0,
  • "mptt_level": 0,
  • "parent": 0
}

Storage Object

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this storage object.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "path": "string",
  • "size": 0,
  • "is_file": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "resource_groups": [ ],
  • "resource_groups_object": [
    ]
}

Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this storage object.

Request Body schema: application/json
required
resource_groups
Array of strings[ items [ 1 .. 1024 ] characters ]
Default: []

Responses

Request samples

Content type
application/json
{
  • "resource_groups": [ ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "path": "string",
  • "size": 0,
  • "is_file": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "resource_groups": [ ],
  • "resource_groups_object": [
    ]
}

Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this storage object.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "path": "string",
  • "size": 0,
  • "is_file": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "resource_groups": [ ],
  • "resource_groups_object": [
    ]
}

Sync

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "task_id": "string"
}

Unzip

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
target_directory_path
required
string (Target directory path) non-empty
file_path
required
string (File path) non-empty

Responses

Request samples

Content type
application/json
{
  • "target_directory_path": "string",
  • "file_path": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "task_id": "string"
}

Upload

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
path
string or null (Path)
Default: "/"
page
integer or null (Page)
Default: 1
page_size
integer or null (Page size)
Default: 40

Responses

Request samples

Content type
application/json
{
  • "path": "/",
  • "page": 1,
  • "page_size": 40
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "path": "string",
  • "details": "string",
  • "files": [
    ],
  • "results": [
    ]
}

View

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
path
required
string non-empty

Responses

Response samples

Content type
application/json
"string"