three.MF.V3.Tasks.ListProjects 

 1from MF.V3.Descriptors.Project import Project as MF_V3_Descriptors_Project_Project
 2from MF.V3.Task import TaskState as MF_V3_Task_TaskState
 3
 4
 5class ListProjects:
 6    """*
 7    List all projects.
 8
 9    > Request example:
10
11    ```json
12    {
13    "Task":{
14    "Index":1,
15    "Type":"ListProjects"
16    }
17    }
18    ```
19
20    > Response example:
21
22    ```json
23    {
24    "Task":{
25    "Index":1,
26    "Type":"ListProjects",
27    "Output":[
28    {"index":1,"modified":[2024,5,12,11,23,17],"name":"Project 1","size":35409834},
29    {"index":2,"modified":[2024,5,12,11,2,37],"name":"Project 2","size":175025367},
30    {"index":3,"modified":[2024,5,6,17,15,53],"name":"Project 3","size":24314083}
31    ],
32    "State":"Completed"
33    }
34    }
35    ```
36    """
37    class Request:
38
39        """
40         Client request for the `ListProjects` task.
41        """
42        def __init__(self, Index: int, Type: str):
43            # A unique identifier generated by the client.
44            self.Index = Index
45            # "ListProjects"
46            self.Type = Type
47
48    class Response:
49
50        """
51         Server response for the `ListProjects` task.
52        """
53        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Project_Project.Brief = None, State: MF_V3_Task_TaskState = None, Error: str = None):
54            # The unique identifier generated by the client.
55            self.Index = Index
56            # "ListProjects"
57            self.Type = Type
58            # Brief project descriptors.
59            self.Output = Output
60            # The current state of the task.
61            self.State = State
62            # A string describing the error if the task has failed.
63            self.Error = Error
64
65    def __init__(self):
66        pass
class ListProjects: 
 6class ListProjects:
 7    """*
 8    List all projects.
 9
10    > Request example:
11
12    ```json
13    {
14    "Task":{
15    "Index":1,
16    "Type":"ListProjects"
17    }
18    }
19    ```
20
21    > Response example:
22
23    ```json
24    {
25    "Task":{
26    "Index":1,
27    "Type":"ListProjects",
28    "Output":[
29    {"index":1,"modified":[2024,5,12,11,23,17],"name":"Project 1","size":35409834},
30    {"index":2,"modified":[2024,5,12,11,2,37],"name":"Project 2","size":175025367},
31    {"index":3,"modified":[2024,5,6,17,15,53],"name":"Project 3","size":24314083}
32    ],
33    "State":"Completed"
34    }
35    }
36    ```
37    """
38    class Request:
39
40        """
41         Client request for the `ListProjects` task.
42        """
43        def __init__(self, Index: int, Type: str):
44            # A unique identifier generated by the client.
45            self.Index = Index
46            # "ListProjects"
47            self.Type = Type
48
49    class Response:
50
51        """
52         Server response for the `ListProjects` task.
53        """
54        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Project_Project.Brief = None, State: MF_V3_Task_TaskState = None, Error: str = None):
55            # The unique identifier generated by the client.
56            self.Index = Index
57            # "ListProjects"
58            self.Type = Type
59            # Brief project descriptors.
60            self.Output = Output
61            # The current state of the task.
62            self.State = State
63            # A string describing the error if the task has failed.
64            self.Error = Error
65
66    def __init__(self):
67        pass

* List all projects.

Request example:

{
"Task":{
"Index":1,
"Type":"ListProjects"
}
}

Response example:

{
"Task":{
"Index":1,
"Type":"ListProjects",
"Output":[
{"index":1,"modified":[2024,5,12,11,23,17],"name":"Project 1","size":35409834},
{"index":2,"modified":[2024,5,12,11,2,37],"name":"Project 2","size":175025367},
{"index":3,"modified":[2024,5,6,17,15,53],"name":"Project 3","size":24314083}
],
"State":"Completed"
}
}
class ListProjects.Request: 
38    class Request:
39
40        """
41         Client request for the `ListProjects` task.
42        """
43        def __init__(self, Index: int, Type: str):
44            # A unique identifier generated by the client.
45            self.Index = Index
46            # "ListProjects"
47            self.Type = Type

Client request for the ListProjects task.

ListProjects.Request(Index: int, Type: str) 
43        def __init__(self, Index: int, Type: str):
44            # A unique identifier generated by the client.
45            self.Index = Index
46            # "ListProjects"
47            self.Type = Type
Index
Type
class ListProjects.Response: 
49    class Response:
50
51        """
52         Server response for the `ListProjects` task.
53        """
54        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Project_Project.Brief = None, State: MF_V3_Task_TaskState = None, Error: str = None):
55            # The unique identifier generated by the client.
56            self.Index = Index
57            # "ListProjects"
58            self.Type = Type
59            # Brief project descriptors.
60            self.Output = Output
61            # The current state of the task.
62            self.State = State
63            # A string describing the error if the task has failed.
64            self.Error = Error

Server response for the ListProjects task.

ListProjects.Response( Index: int, Type: str, Output: MF.V3.Descriptors.Project.Project.Brief = None, State: MF.V3.Task.TaskState = None, Error: str = None) 
54        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Project_Project.Brief = None, State: MF_V3_Task_TaskState = None, Error: str = None):
55            # The unique identifier generated by the client.
56            self.Index = Index
57            # "ListProjects"
58            self.Type = Type
59            # Brief project descriptors.
60            self.Output = Output
61            # The current state of the task.
62            self.State = State
63            # A string describing the error if the task has failed.
64            self.Error = Error
Index
Type
Output
State
Error