\TaskApi

All URIs are relative to http://localhost:5516

Method	HTTP request	Description
AbortTask	Post /api/v1/tasks/{taskId}/abort
AddAttachments	Post /api/v1/tasks/{taskId}/attachments
AddCondition	Post /api/v1/tasks/{taskId}/conditions
AddDependency	Post /api/v1/tasks/{taskId}/dependencies/{targetId}
AddTaskTask	Post /api/v1/tasks/{containerId}/tasks
AssignTask	Post /api/v1/tasks/{taskId}/assign/{username}
ChangeTaskType	Post /api/v1/tasks/{taskId}/changeType
CommentTask	Post /api/v1/tasks/{taskId}/comment
CompleteTask	Post /api/v1/tasks/{taskId}/complete
CopyTask	Post /api/v1/tasks/{taskId}/copy
DeleteAttachment	Delete /api/v1/tasks/{taskId}/attachments/{attachmentId}
DeleteCondition	Delete /api/v1/tasks/{conditionId}
DeleteDependency	Delete /api/v1/tasks/{dependencyId}
DeleteTask	Delete /api/v1/tasks/{taskId}
FailTask	Post /api/v1/tasks/{taskId}/fail
GetTask	Get /api/v1/tasks/{taskId}
GetTaskVariables	Get /api/v1/tasks/{taskId}/variables
LockTask	Put /api/v1/tasks/{taskId}/lock
ReopenTask	Post /api/v1/tasks/{taskId}/reopen
RetryTask	Post /api/v1/tasks/{taskId}/retry
SearchTasksByTitle	Get /api/v1/tasks/byTitle
SkipTask	Post /api/v1/tasks/{taskId}/skip
StartTask	Post /api/v1/tasks/{taskId}/start
StartTask1	Post /api/v1/tasks/{taskId}/startNow
UnlockTask	Delete /api/v1/tasks/{taskId}/lock
UpdateCondition	Post /api/v1/tasks/{conditionId}
UpdateInputVariables	Put /api/v1/tasks/{taskId}/variables
UpdateTask	Put /api/v1/tasks/{taskId}

AbortTask

Task AbortTask(ctx, taskId).Comment1(comment1).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    taskId := "taskId_example" // string | 
    comment1 := *openapiclient.NewComment1() // Comment1 |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TaskApi.AbortTask(context.Background(), taskId).Comment1(comment1).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.AbortTask``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AbortTask`: Task
    fmt.Fprintf(os.Stdout, "Response from `TaskApi.AbortTask`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
taskId	string

Other Parameters

Other parameters are passed through a pointer to a apiAbortTaskRequest struct via the builder pattern

Name	Type	Description	Notes

comment1 | Comment1 | |

Return type

Task

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddAttachments

[]Attachment AddAttachments(ctx, taskId).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    taskId := "taskId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TaskApi.AddAttachments(context.Background(), taskId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.AddAttachments``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AddAttachments`: []Attachment
    fmt.Fprintf(os.Stdout, "Response from `TaskApi.AddAttachments`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
taskId	string

Other Parameters

Other parameters are passed through a pointer to a apiAddAttachmentsRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]Attachment

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddCondition

GateCondition AddCondition(ctx, taskId).Condition1(condition1).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    taskId := "taskId_example" // string | 
    condition1 := *openapiclient.NewCondition1() // Condition1 |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TaskApi.AddCondition(context.Background(), taskId).Condition1(condition1).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.AddCondition``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AddCondition`: GateCondition
    fmt.Fprintf(os.Stdout, "Response from `TaskApi.AddCondition`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
taskId	string

Other Parameters

Other parameters are passed through a pointer to a apiAddConditionRequest struct via the builder pattern

Name	Type	Description	Notes

condition1 | Condition1 | |

Return type

GateCondition

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddDependency

Dependency AddDependency(ctx, targetId, taskId).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    targetId := "targetId_example" // string | 
    taskId := "taskId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TaskApi.AddDependency(context.Background(), targetId, taskId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.AddDependency``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AddDependency`: Dependency
    fmt.Fprintf(os.Stdout, "Response from `TaskApi.AddDependency`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
targetId	string
taskId	string

Other Parameters

Other parameters are passed through a pointer to a apiAddDependencyRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

Dependency

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddTaskTask

Task AddTaskTask(ctx, containerId).Task(task).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    containerId := "containerId_example" // string | 
    task := *openapiclient.NewTask() // Task |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TaskApi.AddTaskTask(context.Background(), containerId).Task(task).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.AddTaskTask``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AddTaskTask`: Task
    fmt.Fprintf(os.Stdout, "Response from `TaskApi.AddTaskTask`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
containerId	string

Other Parameters

Other parameters are passed through a pointer to a apiAddTaskTaskRequest struct via the builder pattern

Name	Type	Description	Notes

task | Task | |

Return type

Task

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AssignTask

Task AssignTask(ctx, taskId, username).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    taskId := "taskId_example" // string | 
    username := "username_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TaskApi.AssignTask(context.Background(), taskId, username).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.AssignTask``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AssignTask`: Task
    fmt.Fprintf(os.Stdout, "Response from `TaskApi.AssignTask`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
taskId	string
username	string

Other Parameters

Other parameters are passed through a pointer to a apiAssignTaskRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

Task

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ChangeTaskType

Task ChangeTaskType(ctx, taskId).TargetType(targetType).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    taskId := "taskId_example" // string | 
    targetType := "targetType_example" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TaskApi.ChangeTaskType(context.Background(), taskId).TargetType(targetType).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.ChangeTaskType``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ChangeTaskType`: Task
    fmt.Fprintf(os.Stdout, "Response from `TaskApi.ChangeTaskType`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
taskId	string

Other Parameters

Other parameters are passed through a pointer to a apiChangeTaskTypeRequest struct via the builder pattern

Name	Type	Description	Notes

targetType | string | |

Return type

Task

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CommentTask

Task CommentTask(ctx, taskId).Comment1(comment1).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    taskId := "taskId_example" // string | 
    comment1 := *openapiclient.NewComment1() // Comment1 |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TaskApi.CommentTask(context.Background(), taskId).Comment1(comment1).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.CommentTask``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CommentTask`: Task
    fmt.Fprintf(os.Stdout, "Response from `TaskApi.CommentTask`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
taskId	string

Other Parameters

Other parameters are passed through a pointer to a apiCommentTaskRequest struct via the builder pattern

Name	Type	Description	Notes

comment1 | Comment1 | |

Return type

Task

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CompleteTask

Task CompleteTask(ctx, taskId).Comment1(comment1).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    taskId := "taskId_example" // string | 
    comment1 := *openapiclient.NewComment1() // Comment1 |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TaskApi.CompleteTask(context.Background(), taskId).Comment1(comment1).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.CompleteTask``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CompleteTask`: Task
    fmt.Fprintf(os.Stdout, "Response from `TaskApi.CompleteTask`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
taskId	string

Other Parameters

Other parameters are passed through a pointer to a apiCompleteTaskRequest struct via the builder pattern

Name	Type	Description	Notes

comment1 | Comment1 | |

Return type

Task

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CopyTask

Task CopyTask(ctx, taskId).TargetContainerId(targetContainerId).TargetPosition(targetPosition).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    taskId := "taskId_example" // string | 
    targetContainerId := "targetContainerId_example" // string |  (optional)
    targetPosition := int32(56) // int32 |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TaskApi.CopyTask(context.Background(), taskId).TargetContainerId(targetContainerId).TargetPosition(targetPosition).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.CopyTask``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CopyTask`: Task
    fmt.Fprintf(os.Stdout, "Response from `TaskApi.CopyTask`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
taskId	string

Other Parameters

Other parameters are passed through a pointer to a apiCopyTaskRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

Task

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteAttachment

DeleteAttachment(ctx, attachmentId, taskId).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    attachmentId := "attachmentId_example" // string | 
    taskId := "taskId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.TaskApi.DeleteAttachment(context.Background(), attachmentId, taskId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.DeleteAttachment``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
attachmentId	string
taskId	string

Other Parameters

Other parameters are passed through a pointer to a apiDeleteAttachmentRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteCondition

DeleteCondition(ctx, conditionId).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    conditionId := "conditionId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.TaskApi.DeleteCondition(context.Background(), conditionId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.DeleteCondition``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
conditionId	string

Other Parameters

Other parameters are passed through a pointer to a apiDeleteConditionRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteDependency

DeleteDependency(ctx, dependencyId).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    dependencyId := "dependencyId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.TaskApi.DeleteDependency(context.Background(), dependencyId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.DeleteDependency``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
dependencyId	string

Other Parameters

Other parameters are passed through a pointer to a apiDeleteDependencyRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteTask

DeleteTask(ctx, taskId).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    taskId := "taskId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.TaskApi.DeleteTask(context.Background(), taskId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.DeleteTask``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
taskId	string

Other Parameters

Other parameters are passed through a pointer to a apiDeleteTaskRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FailTask

Task FailTask(ctx, taskId).Comment1(comment1).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    taskId := "taskId_example" // string | 
    comment1 := *openapiclient.NewComment1() // Comment1 |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TaskApi.FailTask(context.Background(), taskId).Comment1(comment1).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.FailTask``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `FailTask`: Task
    fmt.Fprintf(os.Stdout, "Response from `TaskApi.FailTask`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
taskId	string

Other Parameters

Other parameters are passed through a pointer to a apiFailTaskRequest struct via the builder pattern

Name	Type	Description	Notes

comment1 | Comment1 | |

Return type

Task

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTask

Task GetTask(ctx, taskId).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    taskId := "taskId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TaskApi.GetTask(context.Background(), taskId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.GetTask``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetTask`: Task
    fmt.Fprintf(os.Stdout, "Response from `TaskApi.GetTask`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
taskId	string

Other Parameters

Other parameters are passed through a pointer to a apiGetTaskRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

Task

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTaskVariables

[]Variable GetTaskVariables(ctx, taskId).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    taskId := "taskId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TaskApi.GetTaskVariables(context.Background(), taskId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.GetTaskVariables``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetTaskVariables`: []Variable
    fmt.Fprintf(os.Stdout, "Response from `TaskApi.GetTaskVariables`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
taskId	string

Other Parameters

Other parameters are passed through a pointer to a apiGetTaskVariablesRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]Variable

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LockTask

LockTask(ctx, taskId).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    taskId := "taskId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.TaskApi.LockTask(context.Background(), taskId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.LockTask``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
taskId	string

Other Parameters

Other parameters are passed through a pointer to a apiLockTaskRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReopenTask

Task ReopenTask(ctx, taskId).Comment1(comment1).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    taskId := "taskId_example" // string | 
    comment1 := *openapiclient.NewComment1() // Comment1 |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TaskApi.ReopenTask(context.Background(), taskId).Comment1(comment1).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.ReopenTask``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ReopenTask`: Task
    fmt.Fprintf(os.Stdout, "Response from `TaskApi.ReopenTask`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
taskId	string

Other Parameters

Other parameters are passed through a pointer to a apiReopenTaskRequest struct via the builder pattern

Name	Type	Description	Notes

comment1 | Comment1 | |

Return type

Task

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RetryTask

Task RetryTask(ctx, taskId).Comment1(comment1).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    taskId := "taskId_example" // string | 
    comment1 := *openapiclient.NewComment1() // Comment1 |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TaskApi.RetryTask(context.Background(), taskId).Comment1(comment1).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.RetryTask``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `RetryTask`: Task
    fmt.Fprintf(os.Stdout, "Response from `TaskApi.RetryTask`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
taskId	string

Other Parameters

Other parameters are passed through a pointer to a apiRetryTaskRequest struct via the builder pattern

Name	Type	Description	Notes

comment1 | Comment1 | |

Return type

Task

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SearchTasksByTitle

[]Task SearchTasksByTitle(ctx).PhaseTitle(phaseTitle).ReleaseId(releaseId).TaskTitle(taskTitle).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    phaseTitle := "phaseTitle_example" // string |  (optional)
    releaseId := "releaseId_example" // string |  (optional)
    taskTitle := "taskTitle_example" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TaskApi.SearchTasksByTitle(context.Background()).PhaseTitle(phaseTitle).ReleaseId(releaseId).TaskTitle(taskTitle).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.SearchTasksByTitle``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SearchTasksByTitle`: []Task
    fmt.Fprintf(os.Stdout, "Response from `TaskApi.SearchTasksByTitle`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiSearchTasksByTitleRequest struct via the builder pattern

Name	Type	Description	Notes
phaseTitle	string
releaseId	string
taskTitle	string

Return type

[]Task

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SkipTask

Task SkipTask(ctx, taskId).Comment1(comment1).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    taskId := "taskId_example" // string | 
    comment1 := *openapiclient.NewComment1() // Comment1 |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TaskApi.SkipTask(context.Background(), taskId).Comment1(comment1).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.SkipTask``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SkipTask`: Task
    fmt.Fprintf(os.Stdout, "Response from `TaskApi.SkipTask`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
taskId	string

Other Parameters

Other parameters are passed through a pointer to a apiSkipTaskRequest struct via the builder pattern

Name	Type	Description	Notes

comment1 | Comment1 | |

Return type

Task

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StartTask

Task StartTask(ctx, taskId).StartTask(startTask).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    taskId := "taskId_example" // string | 
    startTask := *openapiclient.NewStartTask() // StartTask |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TaskApi.StartTask(context.Background(), taskId).StartTask(startTask).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.StartTask``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `StartTask`: Task
    fmt.Fprintf(os.Stdout, "Response from `TaskApi.StartTask`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
taskId	string

Other Parameters

Other parameters are passed through a pointer to a apiStartTaskRequest struct via the builder pattern

Name	Type	Description	Notes

startTask | StartTask | |

Return type

Task

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StartTask1

Task StartTask1(ctx, taskId).Comment1(comment1).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    taskId := "taskId_example" // string | 
    comment1 := *openapiclient.NewComment1() // Comment1 |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TaskApi.StartTask1(context.Background(), taskId).Comment1(comment1).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.StartTask1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `StartTask1`: Task
    fmt.Fprintf(os.Stdout, "Response from `TaskApi.StartTask1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
taskId	string

Other Parameters

Other parameters are passed through a pointer to a apiStartTask1Request struct via the builder pattern

Name	Type	Description	Notes

comment1 | Comment1 | |

Return type

Task

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UnlockTask

UnlockTask(ctx, taskId).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    taskId := "taskId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.TaskApi.UnlockTask(context.Background(), taskId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.UnlockTask``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
taskId	string

Other Parameters

Other parameters are passed through a pointer to a apiUnlockTaskRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateCondition

GateCondition UpdateCondition(ctx, conditionId).Condition1(condition1).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    conditionId := "conditionId_example" // string | 
    condition1 := *openapiclient.NewCondition1() // Condition1 |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TaskApi.UpdateCondition(context.Background(), conditionId).Condition1(condition1).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.UpdateCondition``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateCondition`: GateCondition
    fmt.Fprintf(os.Stdout, "Response from `TaskApi.UpdateCondition`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
conditionId	string

Other Parameters

Other parameters are passed through a pointer to a apiUpdateConditionRequest struct via the builder pattern

Name	Type	Description	Notes

condition1 | Condition1 | |

Return type

GateCondition

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateInputVariables

[]Variable UpdateInputVariables(ctx, taskId).Variable(variable).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    taskId := "taskId_example" // string | 
    variable := []openapiclient.Variable{*openapiclient.NewVariable()} // []Variable |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TaskApi.UpdateInputVariables(context.Background(), taskId).Variable(variable).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.UpdateInputVariables``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateInputVariables`: []Variable
    fmt.Fprintf(os.Stdout, "Response from `TaskApi.UpdateInputVariables`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
taskId	string

Other Parameters

Other parameters are passed through a pointer to a apiUpdateInputVariablesRequest struct via the builder pattern

Name	Type	Description	Notes

variable | []Variable | |

Return type

[]Variable

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateTask

Task UpdateTask(ctx, taskId).Task(task).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    taskId := "taskId_example" // string | 
    task := *openapiclient.NewTask() // Task |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TaskApi.UpdateTask(context.Background(), taskId).Task(task).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TaskApi.UpdateTask``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateTask`: Task
    fmt.Fprintf(os.Stdout, "Response from `TaskApi.UpdateTask`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
taskId	string

Other Parameters

Other parameters are passed through a pointer to a apiUpdateTaskRequest struct via the builder pattern

Name	Type	Description	Notes

task | Task | |

Return type

Task

Authorization

basicAuth, patAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

TaskApi.md

Latest commit

History

TaskApi.md

File metadata and controls

\TaskApi

AbortTask

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AddAttachments

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AddCondition

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AddDependency

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AddTaskTask

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AssignTask

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ChangeTaskType

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CommentTask

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CompleteTask

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CopyTask

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteAttachment

Example

Path Parameters