Skip to content

Latest commit

 

History

History
64 lines (53 loc) · 2.39 KB

fileserver.rst

File metadata and controls

64 lines (53 loc) · 2.39 KB

File Server Resource

Resource URL http://mytorrentserver/rundb/api/v1/fileserver/
Schema URL http://mytorrentserver/rundb/api/v1/fileserver/schema/

Resource Fields

field help text default nullable readonly blank unique type
percentfull Floating point numeric data. Ex: 26.73 0 true false false false float
---------------- -------------------------------------- ------- -------- -------- ----- ------ -------
name Unicode string data. Ex: "Hello World" n/a false false false false string
---------------- -------------------------------------- ------- -------- -------- ----- ------ -------
filesPrefix Unicode string data. Ex: "Hello World" n/a false false false false string

----------------comments

--------------------------------------Unicode string data. Ex: "Hello World"


--------false

--------false

-----true

------false

-------string

----------------id

--------------------------------------Integer data. Ex: 2673


--------false

--------false

-----true

------true

-------integer

---------------- -------------------------------------- ------- -------- -------- ----- ------ -------
resource_uri Unicode string data. Ex: "Hello World" n/a false true false false string

Example Response

{
    "meta": {
        "previous": null, 
        "total_count": 1, 
        "offset": 0, 
        "limit": 1, 
        "next": null
    }, 
    "objects": [
        {
            "percentfull": 39.7277052027567, 
            "name": "Home", 
            "filesPrefix": "/results/", 
            "comments": "", 
            "id": 1, 
            "resource_uri": "/rundb/api/v1/fileserver/1/"
        }
    ]
}

Allowed HTTP methods

  • get
  • post
  • put
  • delete
  • patch