Skip to content

Latest commit

 

History

History
347 lines (225 loc) · 9.69 KB

WorkflowCategoriesApi.md

File metadata and controls

347 lines (225 loc) · 9.69 KB
Raw

\WorkflowCategoriesApi

All URIs are relative to http://localhost

Method HTTP request Description
CreateWorkflowCategory Post /workflow/api/v8/categories Creates a new workflow category.
DeleteWorkflowCategory Delete /workflow/api/v8/categories/{id} Deletes a workflow category.
GetWorkflowCategoriesList Get /workflow/api/v8/categories/list Returns a list of workflow categories.
GetWorkflowCategory Get /workflow/api/v8/categories/{id} Returns a workflow category.
UpdateWorkflowCategory Put /workflow/api/v8/categories/{id} Updates a workflow category.

CreateWorkflowCategory

WorkflowCategory CreateWorkflowCategory(ctx).TenantId(tenantId).WorkflowCategoryCreate(workflowCategoryCreate).Execute()

Creates a new workflow category.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    tenantId := TODO // string | 
    workflowCategoryCreate := *openapiclient.NewWorkflowCategoryCreate("Name_example", "Title_example", "Description_example", "SchemaId_example") // WorkflowCategoryCreate | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.WorkflowCategoriesApi.CreateWorkflowCategory(context.Background()).TenantId(tenantId).WorkflowCategoryCreate(workflowCategoryCreate).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WorkflowCategoriesApi.CreateWorkflowCategory``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateWorkflowCategory`: WorkflowCategory
    fmt.Fprintf(os.Stdout, "Response from `WorkflowCategoriesApi.CreateWorkflowCategory`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
tenantId string
workflowCategoryCreate WorkflowCategoryCreate

Return type

WorkflowCategory

Authorization

No authorization required

HTTP request headers

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

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

DeleteWorkflowCategory

DeleteWorkflowCategory(ctx, id).Execute()

Deletes a workflow category.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.WorkflowCategoriesApi.DeleteWorkflowCategory(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WorkflowCategoriesApi.DeleteWorkflowCategory``: %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.
id string

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetWorkflowCategoriesList

[]WorkflowCategory GetWorkflowCategoriesList(ctx).TenantId(tenantId).Execute()

Returns a list of workflow categories.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    tenantId := TODO // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.WorkflowCategoriesApi.GetWorkflowCategoriesList(context.Background()).TenantId(tenantId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WorkflowCategoriesApi.GetWorkflowCategoriesList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetWorkflowCategoriesList`: []WorkflowCategory
    fmt.Fprintf(os.Stdout, "Response from `WorkflowCategoriesApi.GetWorkflowCategoriesList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
tenantId string

Return type

[]WorkflowCategory

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetWorkflowCategory

WorkflowCategory GetWorkflowCategory(ctx, id).Execute()

Returns a workflow category.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | 

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

WorkflowCategory

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

UpdateWorkflowCategory

WorkflowCategory UpdateWorkflowCategory(ctx, id).WorkflowCategoryUpdate(workflowCategoryUpdate).Execute()

Updates a workflow category.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | 
    workflowCategoryUpdate := *openapiclient.NewWorkflowCategoryUpdate("Name_example", "Title_example", "Description_example", "SchemaId_example") // WorkflowCategoryUpdate | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.WorkflowCategoriesApi.UpdateWorkflowCategory(context.Background(), id).WorkflowCategoryUpdate(workflowCategoryUpdate).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WorkflowCategoriesApi.UpdateWorkflowCategory``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateWorkflowCategory`: WorkflowCategory
    fmt.Fprintf(os.Stdout, "Response from `WorkflowCategoriesApi.UpdateWorkflowCategory`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name Type Description Notes

workflowCategoryUpdate | WorkflowCategoryUpdate | |

Return type

WorkflowCategory

Authorization

No authorization required

HTTP request headers

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

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