three.MF.V3.Tasks.RemoveGroups 

 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 RemoveGroups:
 7    """*
 8    Remove selected scan groups.
 9
10    > Request example:
11
12    ```json
13    {
14    "Task":{
15    "Index":1,
16    "Type":"RemoveGroups",
17    "Input":[1,2]
18    }
19    }
20    ```
21
22    > Response example:
23
24    ```json
25    {
26    "Task":{
27    "Index":1,
28    "Type":"RemoveGroups",
29    "Input":[1,2],
30    "Output":{"groups":[]},
31    "State":"Completed"
32    }
33    }
34    ```
35    """
36    class Request:
37
38        """
39         Client request for the `RemoveGroups` task.
40        """
41        def __init__(self, Index: int, Type: str, Input: List[int] = None):
42            # A unique identifier generated by the client.
43            self.Index = Index
44            # "RemoveGroups"
45            self.Type = Type
46            # The list of indices of the scan groups to remove.
47            self.Input = Input
48
49    class Response:
50
51        """
52         Server response for the `RemoveGroups` task.
53        """
54        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Project_Project.Group, Input: List[int] = None, State: MF_V3_Task_TaskState = None, Error: str = None):
55            # The unique identifier generated by the client.
56            self.Index = Index
57            # "RemoveGroups"
58            self.Type = Type
59            # The root scan group in the current open project.
60            self.Output = Output
61            # The requested of indices of the scan groups to remove.
62            self.Input = Input
63            # The current state of the task.
64            self.State = State
65            # A string describing the error if the task has failed.
66            self.Error = Error
67
68    def __init__(self):
69        pass
class RemoveGroups: 
 7class RemoveGroups:
 8    """*
 9    Remove selected scan groups.
10
11    > Request example:
12
13    ```json
14    {
15    "Task":{
16    "Index":1,
17    "Type":"RemoveGroups",
18    "Input":[1,2]
19    }
20    }
21    ```
22
23    > Response example:
24
25    ```json
26    {
27    "Task":{
28    "Index":1,
29    "Type":"RemoveGroups",
30    "Input":[1,2],
31    "Output":{"groups":[]},
32    "State":"Completed"
33    }
34    }
35    ```
36    """
37    class Request:
38
39        """
40         Client request for the `RemoveGroups` task.
41        """
42        def __init__(self, Index: int, Type: str, Input: List[int] = None):
43            # A unique identifier generated by the client.
44            self.Index = Index
45            # "RemoveGroups"
46            self.Type = Type
47            # The list of indices of the scan groups to remove.
48            self.Input = Input
49
50    class Response:
51
52        """
53         Server response for the `RemoveGroups` task.
54        """
55        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Project_Project.Group, Input: List[int] = None, State: MF_V3_Task_TaskState = None, Error: str = None):
56            # The unique identifier generated by the client.
57            self.Index = Index
58            # "RemoveGroups"
59            self.Type = Type
60            # The root scan group in the current open project.
61            self.Output = Output
62            # The requested of indices of the scan groups to remove.
63            self.Input = Input
64            # The current state of the task.
65            self.State = State
66            # A string describing the error if the task has failed.
67            self.Error = Error
68
69    def __init__(self):
70        pass

* Remove selected scan groups.

Request example:

{
"Task":{
"Index":1,
"Type":"RemoveGroups",
"Input":[1,2]
}
}

Response example:

{
"Task":{
"Index":1,
"Type":"RemoveGroups",
"Input":[1,2],
"Output":{"groups":[]},
"State":"Completed"
}
}
class RemoveGroups.Request: 
37    class Request:
38
39        """
40         Client request for the `RemoveGroups` task.
41        """
42        def __init__(self, Index: int, Type: str, Input: List[int] = None):
43            # A unique identifier generated by the client.
44            self.Index = Index
45            # "RemoveGroups"
46            self.Type = Type
47            # The list of indices of the scan groups to remove.
48            self.Input = Input

Client request for the RemoveGroups task.

RemoveGroups.Request(Index: int, Type: str, Input: List[int] = None) 
42        def __init__(self, Index: int, Type: str, Input: List[int] = None):
43            # A unique identifier generated by the client.
44            self.Index = Index
45            # "RemoveGroups"
46            self.Type = Type
47            # The list of indices of the scan groups to remove.
48            self.Input = Input
Index
Type
Input
class RemoveGroups.Response: 
50    class Response:
51
52        """
53         Server response for the `RemoveGroups` task.
54        """
55        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Project_Project.Group, Input: List[int] = None, State: MF_V3_Task_TaskState = None, Error: str = None):
56            # The unique identifier generated by the client.
57            self.Index = Index
58            # "RemoveGroups"
59            self.Type = Type
60            # The root scan group in the current open project.
61            self.Output = Output
62            # The requested of indices of the scan groups to remove.
63            self.Input = Input
64            # The current state of the task.
65            self.State = State
66            # A string describing the error if the task has failed.
67            self.Error = Error

Server response for the RemoveGroups task.

RemoveGroups.Response( Index: int, Type: str, Output: MF.V3.Descriptors.Project.Project.Group, Input: List[int] = None, State: MF.V3.Task.TaskState = None, Error: str = None) 
55        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Project_Project.Group, Input: List[int] = None, State: MF_V3_Task_TaskState = None, Error: str = None):
56            # The unique identifier generated by the client.
57            self.Index = Index
58            # "RemoveGroups"
59            self.Type = Type
60            # The root scan group in the current open project.
61            self.Output = Output
62            # The requested of indices of the scan groups to remove.
63            self.Input = Input
64            # The current state of the task.
65            self.State = State
66            # A string describing the error if the task has failed.
67            self.Error = Error
Index
Type
Output
Input
State
Error