Convert

Convert

Convert a workflow

Request
URI
POST
https://{api_host}/telco/api/workflows/convert
COPY
Request Body

The workflow to be created

workflowConversion of type(s) application/json
Required 
{
    "owner": {
        "subId": "subId",
        "id": "id"
    }
}
workflowOwner
owner
Required

owner

object
original
Required

original

Authentication
This operation uses the following authentication methods.
Responses
200

Workflow successfully converted

Returns workflowBase of type(s) application/json 
{
    "owner": {
        "subId": "subId",
        "id": "id"
    },
    "outputs": {
        "key": {
            "defaultValue": "{}",
            "format": "format",
            "description": "description"
        }
    },
    "variables": {
        "key": {
            "defaultValue": "{}",
            "format": "format",
            "description": "description"
        }
    },
    "schemaVersion": "schemaVersion",
    "attachments": {
        "key": {
            "reference": true,
            "id": "id"
        }
    },
    "inputs": {
        "key": {
            "defaultValue": "{}",
            "format": "format",
            "description": "description",
            "required": true
        }
    },
    "hierarchy": [
        "hierarchy",
        "hierarchy"
    ],
    "description": "description",
    "readOnly": true,
    "version": "version",
    "steps": {
        "key": {
            "nextStepId": "nextStepId",
            "description": "description",
            "inBindings": {
                "key": {
                    "defaultValue": "{}",
                    "format": "format",
                    "exportName": "exportName"
                }
            },
            "conditions": [
                {
                    "name": "name",
                    "nextStepId": "nextStepId",
                    "value": "{}"
                },
                {
                    "name": "name",
                    "nextStepId": "nextStepId",
                    "value": "{}"
                }
            ],
            "outBindings": {
                "key": {
                    "name": "name",
                    "format": "format"
                }
            }
        }
    },
    "tags": [
        {
            "name": "name",
            "autoCreated": true
        },
        {
            "name": "name",
            "autoCreated": true
        }
    ],
    "startStepId": "startStepId",
    "name": "name"
}
string
name
Required

The name of the workflow

string
version
Required

The version of the workflow

string
startStepId
Optional

The identifier of the starting step

string
schemaVersion
Required

The schema version of the workflow

workflowOwner
owner
Required

owner

boolean
readOnly
Required

Can the workflow be modified

string
description
Optional

The description of the workflow

object
inputs
Optional

The inputs of the workflow

object
outputs
Optional

The outputs of the workflow

object
variables
Optional

The variables of the workflow

array of string
hierarchy
Optional

The hierarchical location of the workflow

array of workflowBase_tags
tags
Optional

The tags of the workflow

object
attachments
Optional

The file attachments of the workflow

object
steps
Optional

The steps of the workflow


400

Bad Request

Returns errorResponse of type(s) application/json 
{
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}
array of error
errors
Optional

errors


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Workflow not found

Operation doesn't return any data structure

500

Internal Server Error

Returns errorResponse of type(s) application/json 
{
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}
array of error
errors
Optional

errors


On This Page
Workflow Operations
POST
Convert
PUT
Create
POST
Create By Multi Content
DELETE
Delete
GET
Get
GET
List
POST
Update