Skip to content

WorkflowTemplatesApi.md

Latest commit

 

History

History
179 lines (119 loc) · 5.41 KB

WorkflowTemplatesApi.md

File metadata and controls

179 lines (119 loc) · 5.41 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)

Workflows are in maintenance mode > > The workflows feature is in maintenance mode, and is planned for future deprecation at a date not yet specified. We will work with existing customers using workflows to migrate to a replacement solution when deprecation occurs. Create a template for a feature flag workflow.

Example

import {
    WorkflowTemplatesApi,
    Configuration,
    CreateWorkflowTemplateInput
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new WorkflowTemplatesApi(configuration);

let createWorkflowTemplateInput: CreateWorkflowTemplateInput; //

const { status, data } = await apiInstance.createWorkflowTemplate(
    createWorkflowTemplateInput
);

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 -

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

deleteWorkflowTemplate

deleteWorkflowTemplate()

Delete a workflow template

Example

import {
    WorkflowTemplatesApi,
    Configuration
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new WorkflowTemplatesApi(configuration);

let templateKey: string; //The template key (default to undefined)

const { status, data } = await apiInstance.deleteWorkflowTemplate(
    templateKey
);

Parameters

Name Type Description Notes
templateKey [string] The template key defaults to undefined

Return type

void (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 -

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

getWorkflowTemplates

WorkflowTemplatesListingOutputRep getWorkflowTemplates()

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

Example

import {
    WorkflowTemplatesApi,
    Configuration
} from 'launchdarkly-api-typescript';

const configuration = new Configuration();
const apiInstance = new WorkflowTemplatesApi(configuration);

let summary: boolean; //Whether the entire template object or just a summary should be returned (optional) (default to undefined)
let search: string; //The substring in either the name or description of a template (optional) (default to undefined)

const { status, data } = await apiInstance.getWorkflowTemplates(
    summary,
    search
);

Parameters

Name Type Description Notes
summary [boolean] Whether the entire template object or just a summary should be returned (optional) defaults to undefined
search [string] The substring in either the name or description of a template (optional) defaults to undefined

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 -

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