Skip to content

Latest commit

 

History

History
125 lines (114 loc) · 10.2 KB

pluginresult.rst

File metadata and controls

125 lines (114 loc) · 10.2 KB
Raw

Plugin Result Resource

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

Resource Fields

field help text default nullable readonly blank unique type
major Boolean data. Ex: True n/a false true false false boolean
---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
can_terminate Boolean data. Ex: True n/a false true false false boolean
---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
resultName Unicode string data. Ex: "Hello World" n/a false true false false string
---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
pluginVersion Unicode string data. Ex: "Hello World" n/a false true false false string
---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
result A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
owner A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related

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

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

--------false

--------false

-----true

------true

--------integer
---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
size Unicode string data. Ex: "Hello World" -1 false false false false string
---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
state Unicode string data. Ex: "Hello World" n/a false true false false string
---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
store Unicode string data. Ex: "Hello World" {} false false true false string
---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
files A list of data. Ex: ['abc', 26.73, 8] n/a false true false false list
---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
URL Unicode string data. Ex: "Hello World" n/a false true false false string
---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
plugin_result_jobs Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
path Unicode string data. Ex: "Hello World" n/a false true false false string
---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
endtime A date & time as a string. Ex: "2010-11-10T03:07:43" n/a false true false false datetime
---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
apikey Unicode string data. Ex: "Hello World" n/a true false false false string
---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
plugin A single related resource. Can be either a URI or set of nested resource data. n/a false false false false related
---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
reportLink Unicode string data. Ex: "Hello World" n/a false true false false string
---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
pluginName Unicode string data. Ex: "Hello World" n/a false true false false string
---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
starttime A date & time as a string. Ex: "2010-11-10T03:07:43" n/a false true false false datetime
---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
inodes Unicode string data. Ex: "Hello World" -1 false false false false string
---------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ --------
resource_uri Unicode string data. Ex: "Hello World" n/a false true false false string

Example Response

{
    "meta": {
        "previous": null, 
        "total_count": 15, 
        "offset": 0, 
        "limit": 1, 
        "next": "/rundb/api/v1/pluginresult/?offset=1&limit=1&format=json"
    }, 
    "objects": [
        {
            "major": false, 
            "can_terminate": false, 
            "resultName": "Auto_user_CB1-42-r9723-314wfa-tl_94", 
            "pluginVersion": "5.6.0.0", 
            "result": "/rundb/api/v1/results/6/", 
            "owner": "/rundb/api/v1/user/1/", 
            "id": 22, 
            "size": "25470", 
            "state": "Completed", 
            "store": {}, 
            "files": [
                "FileExporter_block.html"
            ], 
            "URL": "/output/Home/Auto_user_CB1-42-r9723-314wfa-tl_94_006/plugin_out/FileExporter_out.22/", 
            "plugin_result_jobs": [
                {
                    "grid_engine_jobid": -1, 
                    "id": 22, 
                    "state": "Completed", 
                    "starttime": "2017-08-23T21:46:33.000336+00:00", 
                    "endtime": "2017-08-23T21:46:34.000183+00:00", 
                    "config": {}, 
                    "run_level": "last", 
                    "resource_uri": "/rundb/api/v1/PluginResultJob/22/"
                }
            ], 
            "path": "/results/analysis/output/Home/Auto_user_CB1-42-r9723-314wfa-tl_94_006/plugin_out/FileExporter_out.22", 
            "endtime": "2017-08-23T21:46:34.000183+00:00", 
            "apikey": null, 
            "plugin": "/rundb/api/v1/plugin/10/", 
            "reportLink": "/output/Home/Auto_user_CB1-42-r9723-314wfa-tl_94_006/", 
            "pluginName": "FileExporter", 
            "starttime": "2017-08-23T21:46:33.000336+00:00", 
            "inodes": "6", 
            "resource_uri": "/rundb/api/v1/pluginresult/22/"
        }
    ]
}

Allowed HTTP methods

  • get
  • post
  • put
  • delete
  • patch