three.MF.V3.Tasks.CopyGroups 

 1from MF.V3.Descriptors.Project import Project as MF_V3_Descriptors_Project_Project
 2from MF.V3.Settings.CopyGroups import CopyGroups as MF_V3_Settings_CopyGroups_CopyGroups
 3from MF.V3.Task import TaskState as MF_V3_Task_TaskState
 4
 5
 6class CopyGroups:
 7    """*
 8    Copy a set of scan groups.
 9
10    Say we have a scan group three with three groups:
11
12    ```json
13    {
14    "groups":[
15    {"index":1, "name":"Group 1"},
16    {"index":2, "name":"Group 2"},
17    {"index":3, "name":"Group 3"}
18    ],
19    }
20    ```
21
22    and we want to copy groups 1 and 3.
23
24    > Request example:
25
26    ```json
27    {
28    "Task":{
29    "Index":1,
30    "Type":"CopyGroups",
31    "Input":{
32    "sourceIndexes": [1,3],
33    "nameSuffix": "-copy"
34    }
35    }
36    }
37    ```
38
39    > Response example:
40
41    ```json
42    {
43    "Task":{
44    "Index":1,
45    "Type":"CopyGroups",
46    "Input":{"sourceIndexes":[1,3,5]},
47    "Output":{
48    "groups":[
49    {"index":1, "name":"Group 1"},
50    {"index":4, "name":"Group 1-copy"}
51    {"index":2, "name":"Group 2"},
52    {"index":3, "name":"Group 3"},
53    {"index":5, "name":"Group 3-copy"},
54    ],
55    },
56    "State":"Completed"
57    }
58    }
59    ```
60    """
61    class Request:
62
63        """
64         Client request for the `CopyGroups` task.
65        """
66        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_CopyGroups_CopyGroups):
67            # A unique identifier generated by the client.
68            self.Index = Index
69            # "CopyGroups"
70            self.Type = Type
71            # The copy groups settings.
72            self.Input = Input
73
74    class Response:
75
76        """
77         Server response for the `CopyGroups` task.
78        """
79        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_CopyGroups_CopyGroups, Output: MF_V3_Descriptors_Project_Project.Group, State: MF_V3_Task_TaskState = None, Error: str = None):
80            # The unique identifier generated by the client.
81            self.Index = Index
82            # "CopyGroups"
83            self.Type = Type
84            # The requested copy groups settings.
85            self.Input = Input
86            # The root scan group in the current open project.
87            self.Output = Output
88            # The current state of the task.
89            self.State = State
90            # A string describing the error if the task has failed.
91            self.Error = Error
92
93    def __init__(self):
94        pass
class CopyGroups: 
 7class CopyGroups:
 8    """*
 9    Copy a set of scan groups.
10
11    Say we have a scan group three with three groups:
12
13    ```json
14    {
15    "groups":[
16    {"index":1, "name":"Group 1"},
17    {"index":2, "name":"Group 2"},
18    {"index":3, "name":"Group 3"}
19    ],
20    }
21    ```
22
23    and we want to copy groups 1 and 3.
24
25    > Request example:
26
27    ```json
28    {
29    "Task":{
30    "Index":1,
31    "Type":"CopyGroups",
32    "Input":{
33    "sourceIndexes": [1,3],
34    "nameSuffix": "-copy"
35    }
36    }
37    }
38    ```
39
40    > Response example:
41
42    ```json
43    {
44    "Task":{
45    "Index":1,
46    "Type":"CopyGroups",
47    "Input":{"sourceIndexes":[1,3,5]},
48    "Output":{
49    "groups":[
50    {"index":1, "name":"Group 1"},
51    {"index":4, "name":"Group 1-copy"}
52    {"index":2, "name":"Group 2"},
53    {"index":3, "name":"Group 3"},
54    {"index":5, "name":"Group 3-copy"},
55    ],
56    },
57    "State":"Completed"
58    }
59    }
60    ```
61    """
62    class Request:
63
64        """
65         Client request for the `CopyGroups` task.
66        """
67        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_CopyGroups_CopyGroups):
68            # A unique identifier generated by the client.
69            self.Index = Index
70            # "CopyGroups"
71            self.Type = Type
72            # The copy groups settings.
73            self.Input = Input
74
75    class Response:
76
77        """
78         Server response for the `CopyGroups` task.
79        """
80        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_CopyGroups_CopyGroups, Output: MF_V3_Descriptors_Project_Project.Group, State: MF_V3_Task_TaskState = None, Error: str = None):
81            # The unique identifier generated by the client.
82            self.Index = Index
83            # "CopyGroups"
84            self.Type = Type
85            # The requested copy groups settings.
86            self.Input = Input
87            # The root scan group in the current open project.
88            self.Output = Output
89            # The current state of the task.
90            self.State = State
91            # A string describing the error if the task has failed.
92            self.Error = Error
93
94    def __init__(self):
95        pass

* Copy a set of scan groups.

Say we have a scan group three with three groups:

{
"groups":[
{"index":1, "name":"Group 1"},
{"index":2, "name":"Group 2"},
{"index":3, "name":"Group 3"}
],
}

and we want to copy groups 1 and 3.

Request example:

{
"Task":{
"Index":1,
"Type":"CopyGroups",
"Input":{
"sourceIndexes": [1,3],
"nameSuffix": "-copy"
}
}
}

Response example:

{
"Task":{
"Index":1,
"Type":"CopyGroups",
"Input":{"sourceIndexes":[1,3,5]},
"Output":{
"groups":[
{"index":1, "name":"Group 1"},
{"index":4, "name":"Group 1-copy"}
{"index":2, "name":"Group 2"},
{"index":3, "name":"Group 3"},
{"index":5, "name":"Group 3-copy"},
],
},
"State":"Completed"
}
}
class CopyGroups.Request: 
62    class Request:
63
64        """
65         Client request for the `CopyGroups` task.
66        """
67        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_CopyGroups_CopyGroups):
68            # A unique identifier generated by the client.
69            self.Index = Index
70            # "CopyGroups"
71            self.Type = Type
72            # The copy groups settings.
73            self.Input = Input

Client request for the CopyGroups task.

CopyGroups.Request(Index: int, Type: str, Input: MF.V3.Settings.CopyGroups.CopyGroups) 
67        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_CopyGroups_CopyGroups):
68            # A unique identifier generated by the client.
69            self.Index = Index
70            # "CopyGroups"
71            self.Type = Type
72            # The copy groups settings.
73            self.Input = Input
Index
Type
Input
class CopyGroups.Response: 
75    class Response:
76
77        """
78         Server response for the `CopyGroups` task.
79        """
80        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_CopyGroups_CopyGroups, Output: MF_V3_Descriptors_Project_Project.Group, State: MF_V3_Task_TaskState = None, Error: str = None):
81            # The unique identifier generated by the client.
82            self.Index = Index
83            # "CopyGroups"
84            self.Type = Type
85            # The requested copy groups settings.
86            self.Input = Input
87            # The root scan group in the current open project.
88            self.Output = Output
89            # The current state of the task.
90            self.State = State
91            # A string describing the error if the task has failed.
92            self.Error = Error

Server response for the CopyGroups task.

CopyGroups.Response( Index: int, Type: str, Input: MF.V3.Settings.CopyGroups.CopyGroups, Output: MF.V3.Descriptors.Project.Project.Group, State: MF.V3.Task.TaskState = None, Error: str = None) 
80        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_CopyGroups_CopyGroups, Output: MF_V3_Descriptors_Project_Project.Group, State: MF_V3_Task_TaskState = None, Error: str = None):
81            # The unique identifier generated by the client.
82            self.Index = Index
83            # "CopyGroups"
84            self.Type = Type
85            # The requested copy groups settings.
86            self.Input = Input
87            # The root scan group in the current open project.
88            self.Output = Output
89            # The current state of the task.
90            self.State = State
91            # A string describing the error if the task has failed.
92            self.Error = Error
Index
Type
Input
Output
State
Error