three.MF.V3.Tasks.NewProject
1from MF.V3.Descriptors.Project import Project as MF_V3_Descriptors_Project_Project 2from MF.V3.Settings.Project import Project as MF_V3_Settings_Project_Project 3from MF.V3.Task import TaskState as MF_V3_Task_TaskState 4 5 6class NewProject: 7 """* 8 Create a new project. 9 10 > Request example: 11 12 ```json 13 { 14 "Task":{ 15 "Index":1, 16 "Type":"NewProject", 17 "Input":"New Project Name" 18 } 19 } 20 ``` 21 22 > Response example: 23 24 ```json 25 { 26 "Task":{ 27 "Index":1, 28 "Type":"NewProject", 29 "Input":{ 30 "name":"New Project Name" 31 }, 32 "Output":{ 33 "index":5, 34 "name":"New Project Name" 35 } 36 "State":"Completed" 37 } 38 } 39 ``` 40 """ 41 class Request: 42 43 """ 44 Client request for the `NewProject` task. 45 """ 46 def __init__(self, Index: int, Type: str, Input: str = None): 47 # A unique identifier generated by the client. 48 self.Index = Index 49 # "NewProject" 50 self.Type = Type 51 # Optional new project name. 52 self.Input = Input 53 54 class Response: 55 56 """ 57 Server response for the `NewProject` task. 58 """ 59 def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Project_Project = None, Output: MF_V3_Descriptors_Project_Project = None, State: MF_V3_Task_TaskState = None, Error: str = None): 60 # The unique identifier generated by the client. 61 self.Index = Index 62 # "NewProject" 63 self.Type = Type 64 # Requested new project name. 65 self.Input = Input 66 # The new project descriptor. 67 self.Output = Output 68 # The current state of the task. 69 self.State = State 70 # A string describing the error if the task has failed. 71 self.Error = Error 72 73 def __init__(self): 74 pass
class
NewProject:
7class NewProject: 8 """* 9 Create a new project. 10 11 > Request example: 12 13 ```json 14 { 15 "Task":{ 16 "Index":1, 17 "Type":"NewProject", 18 "Input":"New Project Name" 19 } 20 } 21 ``` 22 23 > Response example: 24 25 ```json 26 { 27 "Task":{ 28 "Index":1, 29 "Type":"NewProject", 30 "Input":{ 31 "name":"New Project Name" 32 }, 33 "Output":{ 34 "index":5, 35 "name":"New Project Name" 36 } 37 "State":"Completed" 38 } 39 } 40 ``` 41 """ 42 class Request: 43 44 """ 45 Client request for the `NewProject` task. 46 """ 47 def __init__(self, Index: int, Type: str, Input: str = None): 48 # A unique identifier generated by the client. 49 self.Index = Index 50 # "NewProject" 51 self.Type = Type 52 # Optional new project name. 53 self.Input = Input 54 55 class Response: 56 57 """ 58 Server response for the `NewProject` task. 59 """ 60 def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Project_Project = None, Output: MF_V3_Descriptors_Project_Project = None, State: MF_V3_Task_TaskState = None, Error: str = None): 61 # The unique identifier generated by the client. 62 self.Index = Index 63 # "NewProject" 64 self.Type = Type 65 # Requested new project name. 66 self.Input = Input 67 # The new project descriptor. 68 self.Output = Output 69 # The current state of the task. 70 self.State = State 71 # A string describing the error if the task has failed. 72 self.Error = Error 73 74 def __init__(self): 75 pass
* Create a new project.
Request example:
{
"Task":{
"Index":1,
"Type":"NewProject",
"Input":"New Project Name"
}
}
Response example:
{
"Task":{
"Index":1,
"Type":"NewProject",
"Input":{
"name":"New Project Name"
},
"Output":{
"index":5,
"name":"New Project Name"
}
"State":"Completed"
}
}
class
NewProject.Request:
42 class Request: 43 44 """ 45 Client request for the `NewProject` task. 46 """ 47 def __init__(self, Index: int, Type: str, Input: str = None): 48 # A unique identifier generated by the client. 49 self.Index = Index 50 # "NewProject" 51 self.Type = Type 52 # Optional new project name. 53 self.Input = Input
Client request for the NewProject
task.
class
NewProject.Response:
55 class Response: 56 57 """ 58 Server response for the `NewProject` task. 59 """ 60 def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Project_Project = None, Output: MF_V3_Descriptors_Project_Project = None, State: MF_V3_Task_TaskState = None, Error: str = None): 61 # The unique identifier generated by the client. 62 self.Index = Index 63 # "NewProject" 64 self.Type = Type 65 # Requested new project name. 66 self.Input = Input 67 # The new project descriptor. 68 self.Output = Output 69 # The current state of the task. 70 self.State = State 71 # A string describing the error if the task has failed. 72 self.Error = Error
Server response for the NewProject
task.
NewProject.Response( Index: int, Type: str, Input: MF.V3.Settings.Project.Project = None, Output: MF.V3.Descriptors.Project.Project = None, State: MF.V3.Task.TaskState = None, Error: str = None)
60 def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Project_Project = None, Output: MF_V3_Descriptors_Project_Project = None, State: MF_V3_Task_TaskState = None, Error: str = None): 61 # The unique identifier generated by the client. 62 self.Index = Index 63 # "NewProject" 64 self.Type = Type 65 # Requested new project name. 66 self.Input = Input 67 # The new project descriptor. 68 self.Output = Output 69 # The current state of the task. 70 self.State = State 71 # A string describing the error if the task has failed. 72 self.Error = Error