Skip to content

Latest commit

 

History

History
231 lines (179 loc) · 7.99 KB

WorkflowTemplatesApi.md

File metadata and controls

231 lines (179 loc) · 7.99 KB

WorkflowTemplatesApi

All URIs are relative to https://app.launchdarkly.com

Method HTTP request Description
createWorkflowTemplate POST /api/v2/templates Create workflow template
deleteWorkflowTemplate DELETE /api/v2/templates/{templateKey} Delete workflow template
getWorkflowTemplates GET /api/v2/templates Get workflow templates

createWorkflowTemplate

WorkflowTemplateOutput createWorkflowTemplate(createWorkflowTemplateInput)

Create workflow template

Create a template for a feature flag workflow

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.WorkflowTemplatesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    WorkflowTemplatesApi apiInstance = new WorkflowTemplatesApi(defaultClient);
    CreateWorkflowTemplateInput createWorkflowTemplateInput = new CreateWorkflowTemplateInput(); // CreateWorkflowTemplateInput | 
    try {
      WorkflowTemplateOutput result = apiInstance.createWorkflowTemplate(createWorkflowTemplateInput);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling WorkflowTemplatesApi#createWorkflowTemplate");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
createWorkflowTemplateInput CreateWorkflowTemplateInput

Return type

WorkflowTemplateOutput

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 Workflow template response JSON -
400 Invalid request -
401 Invalid access token -
403 Forbidden -
429 Rate limited -

deleteWorkflowTemplate

deleteWorkflowTemplate(templateKey)

Delete workflow template

Delete a workflow template

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.WorkflowTemplatesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    WorkflowTemplatesApi apiInstance = new WorkflowTemplatesApi(defaultClient);
    String templateKey = "templateKey_example"; // String | The template key
    try {
      apiInstance.deleteWorkflowTemplate(templateKey);
    } catch (ApiException e) {
      System.err.println("Exception when calling WorkflowTemplatesApi#deleteWorkflowTemplate");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
templateKey String The template key

Return type

null (empty response body)

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 Action completed successfully -
400 Invalid request -
401 Invalid access token -
403 Forbidden -
404 Invalid resource identifier -
429 Rate limited -

getWorkflowTemplates

WorkflowTemplatesListingOutputRep getWorkflowTemplates(summary, search)

Get workflow templates

Get workflow templates belonging to an account, or can optionally return templates_endpoints.workflowTemplateSummariesListingOutputRep when summary query param is true

Example

// Import classes:
import com.launchdarkly.api.ApiClient;
import com.launchdarkly.api.ApiException;
import com.launchdarkly.api.Configuration;
import com.launchdarkly.api.auth.*;
import com.launchdarkly.api.models.*;
import com.launchdarkly.api.api.WorkflowTemplatesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://app.launchdarkly.com");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    WorkflowTemplatesApi apiInstance = new WorkflowTemplatesApi(defaultClient);
    Boolean summary = true; // Boolean | Whether the entire template object or just a summary should be returned
    String search = "search_example"; // String | The substring in either the name or description of a template
    try {
      WorkflowTemplatesListingOutputRep result = apiInstance.getWorkflowTemplates(summary, search);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling WorkflowTemplatesApi#getWorkflowTemplates");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
summary Boolean Whether the entire template object or just a summary should be returned [optional]
search String The substring in either the name or description of a template [optional]

Return type

WorkflowTemplatesListingOutputRep

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Workflow templates list response JSON -
401 Invalid access token -
404 Invalid resource identifier -
429 Rate limited -