three.MF.V3.Tasks.ListScans 

 1from MF.V3.Descriptors.Project import Project as MF_V3_Descriptors_Project_Project
 2from MF.V3.Task import TaskState as MF_V3_Task_TaskState
 3from typing import List
 4
 5
 6class ListScans:
 7    """*
 8    List the scans in the current open project.
 9
10    > Request example:
11
12    ```json
13    {
14    "Task":{
15    "Index":1,
16    "Type":"ListScans"
17    }
18    }
19    ```
20
21    > Response example:
22
23    ```json
24    {
25    "Task":{
26    "Index":1,
27    "Type":"ListScans",
28    "Output":{[
29    {
30    "color":[0.8,0.5,0.6,1.0],
31    "index":1,
32    "name":"Scan-1",
33    "scan":1,
34    "rotation":[0.2,0.8,-0.1],
35    "translation":[-275,-32,-134],
36    "visible":true
37    },
38    {
39    "color":[0.5,0.7,0.2,1.0],
40    "index":2,
41    "name":"Scan-2",
42    "scan":2,
43    "rotation":[0.7,-0.5,0.3],
44    "translation":[75,-62,38],
45    "visible":true
46    },
47    ]},
48    "State":"Completed"
49    }
50    }
51    ```
52    """
53    class Request:
54
55        """
56         Client request for the `ListScans` task.
57        """
58        def __init__(self, Index: int, Type: str):
59            # A unique identifier generated by the client.
60            self.Index = Index
61            # "ListScans"
62            self.Type = Type
63
64    class Response:
65
66        """
67         Server response for the `ListScans` task.
68        """
69        def __init__(self, Index: int, Type: str, Output: List[MF_V3_Descriptors_Project_Project.Group] = None, State: MF_V3_Task_TaskState = None, Error: str = None):
70            # The unique identifier generated by the client.
71            self.Index = Index
72            # "ListScans"
73            self.Type = Type
74            # The list of scans in the current open project.
75            self.Output = Output
76            # The current state of the task.
77            self.State = State
78            # A string describing the error if the task has failed.
79            self.Error = Error
80
81    def __init__(self):
82        pass
class ListScans: 
 7class ListScans:
 8    """*
 9    List the scans in the current open project.
10
11    > Request example:
12
13    ```json
14    {
15    "Task":{
16    "Index":1,
17    "Type":"ListScans"
18    }
19    }
20    ```
21
22    > Response example:
23
24    ```json
25    {
26    "Task":{
27    "Index":1,
28    "Type":"ListScans",
29    "Output":{[
30    {
31    "color":[0.8,0.5,0.6,1.0],
32    "index":1,
33    "name":"Scan-1",
34    "scan":1,
35    "rotation":[0.2,0.8,-0.1],
36    "translation":[-275,-32,-134],
37    "visible":true
38    },
39    {
40    "color":[0.5,0.7,0.2,1.0],
41    "index":2,
42    "name":"Scan-2",
43    "scan":2,
44    "rotation":[0.7,-0.5,0.3],
45    "translation":[75,-62,38],
46    "visible":true
47    },
48    ]},
49    "State":"Completed"
50    }
51    }
52    ```
53    """
54    class Request:
55
56        """
57         Client request for the `ListScans` task.
58        """
59        def __init__(self, Index: int, Type: str):
60            # A unique identifier generated by the client.
61            self.Index = Index
62            # "ListScans"
63            self.Type = Type
64
65    class Response:
66
67        """
68         Server response for the `ListScans` task.
69        """
70        def __init__(self, Index: int, Type: str, Output: List[MF_V3_Descriptors_Project_Project.Group] = None, State: MF_V3_Task_TaskState = None, Error: str = None):
71            # The unique identifier generated by the client.
72            self.Index = Index
73            # "ListScans"
74            self.Type = Type
75            # The list of scans in the current open project.
76            self.Output = Output
77            # The current state of the task.
78            self.State = State
79            # A string describing the error if the task has failed.
80            self.Error = Error
81
82    def __init__(self):
83        pass

* List the scans in the current open project.

Request example:

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

Response example:

{
"Task":{
"Index":1,
"Type":"ListScans",
"Output":{[
{
"color":[0.8,0.5,0.6,1.0],
"index":1,
"name":"Scan-1",
"scan":1,
"rotation":[0.2,0.8,-0.1],
"translation":[-275,-32,-134],
"visible":true
},
{
"color":[0.5,0.7,0.2,1.0],
"index":2,
"name":"Scan-2",
"scan":2,
"rotation":[0.7,-0.5,0.3],
"translation":[75,-62,38],
"visible":true
},
]},
"State":"Completed"
}
}
class ListScans.Request: 
54    class Request:
55
56        """
57         Client request for the `ListScans` task.
58        """
59        def __init__(self, Index: int, Type: str):
60            # A unique identifier generated by the client.
61            self.Index = Index
62            # "ListScans"
63            self.Type = Type

Client request for the ListScans task.

ListScans.Request(Index: int, Type: str) 
59        def __init__(self, Index: int, Type: str):
60            # A unique identifier generated by the client.
61            self.Index = Index
62            # "ListScans"
63            self.Type = Type
Index
Type
class ListScans.Response: 
65    class Response:
66
67        """
68         Server response for the `ListScans` task.
69        """
70        def __init__(self, Index: int, Type: str, Output: List[MF_V3_Descriptors_Project_Project.Group] = None, State: MF_V3_Task_TaskState = None, Error: str = None):
71            # The unique identifier generated by the client.
72            self.Index = Index
73            # "ListScans"
74            self.Type = Type
75            # The list of scans in the current open project.
76            self.Output = Output
77            # The current state of the task.
78            self.State = State
79            # A string describing the error if the task has failed.
80            self.Error = Error

Server response for the ListScans task.

ListScans.Response( Index: int, Type: str, Output: List[MF.V3.Descriptors.Project.Project.Group] = None, State: MF.V3.Task.TaskState = None, Error: str = None) 
70        def __init__(self, Index: int, Type: str, Output: List[MF_V3_Descriptors_Project_Project.Group] = None, State: MF_V3_Task_TaskState = None, Error: str = None):
71            # The unique identifier generated by the client.
72            self.Index = Index
73            # "ListScans"
74            self.Type = Type
75            # The list of scans in the current open project.
76            self.Output = Output
77            # The current state of the task.
78            self.State = State
79            # A string describing the error if the task has failed.
80            self.Error = Error
Index
Type
Output
State
Error