three.MF.V3.Tasks.MoveGroup 

 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 MoveGroup:
 7    """*
 8    Move a scan group.
 9
10    > Request example:
11
12    ```json
13    {
14    "Task":{
15    "Index":1,
16    "Type":"MoveGroup",
17    "Input":[1,2,0]
18    }
19    }
20    ```
21
22    > Response example:
23
24    ```json
25    {
26    "Task":{
27    "Index":1,
28    "Type":"MoveGroup",
29    "Input":[1,2,0],
30    "Output":{
31    "groups":[{
32    "index":2,
33    "name":"Group 2",
34    "groups":[{
35    "index":1,
36    "name":"Group 1"
37    }]
38    }],
39    },
40    "State":"Completed"
41    }
42    }
43    ```
44    """
45    class Request:
46
47        """
48         Client request for the `MoveGroup` task.
49        """
50        def __init__(self, Index: int, Type: str, Input: List[int] = None):
51            # A unique identifier generated by the client.
52            self.Index = Index
53            # "MoveGroup"
54            self.Type = Type
55            """
56            The requested source and destination move indices.
57            An Array of group indexes where
58            1. The first is the index of the _source group_: the group to be moved.
59            2. The second is the index of the _parent group_: the group into which the source group is moved.
60            3. (Optional) The third is the zero-based order in which the source group is placed the other children of the parent group. Use `0` to insert the source group at the beginning of the parent group's children. If omitted, the source group is inserted at the end of the parent group's children.
61            """
62            self.Input = Input
63
64    class Response:
65
66        """
67         Server response for the `MoveGroup` task.
68        """
69        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):
70            # The unique identifier generated by the client.
71            self.Index = Index
72            # "MoveGroup"
73            self.Type = Type
74            # The root scan group in the current open project.
75            self.Output = Output
76            # The requested source and destination move indices.
77            self.Input = Input
78            # The current state of the task.
79            self.State = State
80            # A string describing the error if the task has failed.
81            self.Error = Error
82
83    def __init__(self):
84        pass
class MoveGroup: 
 7class MoveGroup:
 8    """*
 9    Move a scan group.
10
11    > Request example:
12
13    ```json
14    {
15    "Task":{
16    "Index":1,
17    "Type":"MoveGroup",
18    "Input":[1,2,0]
19    }
20    }
21    ```
22
23    > Response example:
24
25    ```json
26    {
27    "Task":{
28    "Index":1,
29    "Type":"MoveGroup",
30    "Input":[1,2,0],
31    "Output":{
32    "groups":[{
33    "index":2,
34    "name":"Group 2",
35    "groups":[{
36    "index":1,
37    "name":"Group 1"
38    }]
39    }],
40    },
41    "State":"Completed"
42    }
43    }
44    ```
45    """
46    class Request:
47
48        """
49         Client request for the `MoveGroup` task.
50        """
51        def __init__(self, Index: int, Type: str, Input: List[int] = None):
52            # A unique identifier generated by the client.
53            self.Index = Index
54            # "MoveGroup"
55            self.Type = Type
56            """
57            The requested source and destination move indices.
58            An Array of group indexes where
59            1. The first is the index of the _source group_: the group to be moved.
60            2. The second is the index of the _parent group_: the group into which the source group is moved.
61            3. (Optional) The third is the zero-based order in which the source group is placed the other children of the parent group. Use `0` to insert the source group at the beginning of the parent group's children. If omitted, the source group is inserted at the end of the parent group's children.
62            """
63            self.Input = Input
64
65    class Response:
66
67        """
68         Server response for the `MoveGroup` task.
69        """
70        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):
71            # The unique identifier generated by the client.
72            self.Index = Index
73            # "MoveGroup"
74            self.Type = Type
75            # The root scan group in the current open project.
76            self.Output = Output
77            # The requested source and destination move indices.
78            self.Input = Input
79            # The current state of the task.
80            self.State = State
81            # A string describing the error if the task has failed.
82            self.Error = Error
83
84    def __init__(self):
85        pass

* Move a scan group.

Request example:

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

Response example:

{
"Task":{
"Index":1,
"Type":"MoveGroup",
"Input":[1,2,0],
"Output":{
"groups":[{
"index":2,
"name":"Group 2",
"groups":[{
"index":1,
"name":"Group 1"
}]
}],
},
"State":"Completed"
}
}
class MoveGroup.Request: 
46    class Request:
47
48        """
49         Client request for the `MoveGroup` task.
50        """
51        def __init__(self, Index: int, Type: str, Input: List[int] = None):
52            # A unique identifier generated by the client.
53            self.Index = Index
54            # "MoveGroup"
55            self.Type = Type
56            """
57            The requested source and destination move indices.
58            An Array of group indexes where
59            1. The first is the index of the _source group_: the group to be moved.
60            2. The second is the index of the _parent group_: the group into which the source group is moved.
61            3. (Optional) The third is the zero-based order in which the source group is placed the other children of the parent group. Use `0` to insert the source group at the beginning of the parent group's children. If omitted, the source group is inserted at the end of the parent group's children.
62            """
63            self.Input = Input

Client request for the MoveGroup task.

MoveGroup.Request(Index: int, Type: str, Input: List[int] = None) 
51        def __init__(self, Index: int, Type: str, Input: List[int] = None):
52            # A unique identifier generated by the client.
53            self.Index = Index
54            # "MoveGroup"
55            self.Type = Type
56            """
57            The requested source and destination move indices.
58            An Array of group indexes where
59            1. The first is the index of the _source group_: the group to be moved.
60            2. The second is the index of the _parent group_: the group into which the source group is moved.
61            3. (Optional) The third is the zero-based order in which the source group is placed the other children of the parent group. Use `0` to insert the source group at the beginning of the parent group's children. If omitted, the source group is inserted at the end of the parent group's children.
62            """
63            self.Input = Input
Index
Type

The requested source and destination move indices. An Array of group indexes where

  1. The first is the index of the _source group_: the group to be moved.
  2. The second is the index of the _parent group_: the group into which the source group is moved.
  3. (Optional) The third is the zero-based order in which the source group is placed the other children of the parent group. Use 0 to insert the source group at the beginning of the parent group's children. If omitted, the source group is inserted at the end of the parent group's children.
Input
class MoveGroup.Response: 
65    class Response:
66
67        """
68         Server response for the `MoveGroup` task.
69        """
70        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):
71            # The unique identifier generated by the client.
72            self.Index = Index
73            # "MoveGroup"
74            self.Type = Type
75            # The root scan group in the current open project.
76            self.Output = Output
77            # The requested source and destination move indices.
78            self.Input = Input
79            # The current state of the task.
80            self.State = State
81            # A string describing the error if the task has failed.
82            self.Error = Error

Server response for the MoveGroup task.

MoveGroup.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) 
70        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):
71            # The unique identifier generated by the client.
72            self.Index = Index
73            # "MoveGroup"
74            self.Type = Type
75            # The root scan group in the current open project.
76            self.Output = Output
77            # The requested source and destination move indices.
78            self.Input = Input
79            # The current state of the task.
80            self.State = State
81            # A string describing the error if the task has failed.
82            self.Error = Error
Index
Type
Output
Input
State
Error