Jump to

• Request
• Response

Start a Dynamic Entities Migration

post

/api/v1/bots/{botId}/metadataMigration/dynamicEntitiesMigrationRequests

Migrates dynamic entities from a source skill to a target skill. As part of the migration process, it will create dynamic entity push requests with the copy query parameter set to false, which means it clears all values in the target entity, uploads all values in the push request, and then starts the training. If any of the push requests fail during the training step, all push requests (and the parent migration request) will complete with an error and no changes will be made to the target skill.

Request

Path Parameters

• botId(required): string
  The ID of the skill to migrate the dynamic entities into.

Query Parameters

• sourceBotId(required): string
  The ID of the skill that contains the entities to be migrated. This skill must have the same name as the target, have been versioned from it, and use the same multilingual mode. If using native multilingual mode, the primary native language should also be the same as the target.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

201 Response

Migration request created.

Body ()

Root Schema : DynamicEntitiesMigrationRequest

Type: object

Dynamic Entities Migration Request

Show Source

• botId: string
  Read Only: true

  The target skill ID for the migration request.
• createdOn: string (date-time)
  Read Only: true

  The date and time, in ISO 8601 format, that the resource was created (for example, 2018-10-17T06:50:34.045Z).
• id: string
  Read Only: true

  The resource's unique ID.
• links: array links
  Read Only: true

  An array of links to the resource.
• sourceBotId: string
  Read Only: true

  The source skill ID for the migration request.
• status: string
  Read Only: true

  Allowed Values: [ "TRAINING", "COMPLETED", "TERMINATED_BY_ERROR" ]

  The status of the migration request.
• statusMessage: string
  Read Only: true

  The message associated with the migration request.
• updatedOn: string (date-time)
  Read Only: true

  The date and time, in ISO 8601 format, that the resource was last modified (for example, 2018-10-17T06:50:34.045Z).

{
    "type":"object",
    "properties":{
        "createdOn":{
            "type":"string",
            "description":"The date and time, in ISO 8601 format, that the resource was created (for example, <code>2018-10-17T06:50:34.045Z</code>).",
            "format":"date-time",
            "readOnly":true
        },
        "updatedOn":{
            "type":"string",
            "description":"The date and time, in ISO 8601 format, that the resource was last modified (for example, <code>2018-10-17T06:50:34.045Z</code>).",
            "format":"date-time",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "properties":{
                "selfLinks":{
                    "type":"object",
                    "properties":{
                        "absolutePathBuilder":{
                            "type":"object"
                        },
                        "baseUri":{
                            "type":"string",
                            "format":"uri"
                        },
                        "requestUri":{
                            "type":"string",
                            "format":"uri"
                        },
                        "requestUriBuilder":{
                            "type":"object"
                        },
                        "baseUriBuilder":{
                            "type":"object"
                        },
                        "pathParameters":{
                            "type":"object",
                            "additionalProperties":{
                                "type":"array",
                                "items":{
                                    "type":"string"
                                }
                            }
                        },
                        "queryParameters":{
                            "type":"object",
                            "additionalProperties":{
                                "type":"array",
                                "items":{
                                    "type":"string"
                                }
                            }
                        },
                        "matchedURIs":{
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        },
                        "matchedResources":{
                            "type":"array",
                            "items":{
                                "type":"object"
                            }
                        },
                        "pathSegments":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "matrixParameters":{
                                        "type":"object",
                                        "additionalProperties":{
                                            "type":"array",
                                            "items":{
                                                "type":"string"
                                            }
                                        }
                                    },
                                    "path":{
                                        "type":"string"
                                    }
                                }
                            }
                        },
                        "absolutePath":{
                            "type":"string",
                            "format":"uri"
                        },
                        "path":{
                            "type":"string"
                        }
                    },
                    "writeOnly":true
                },
                "empty":{
                    "type":"boolean"
                }
            },
            "description":"An array of links to the resource.",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "id":{
            "type":"string",
            "description":"The resource's unique ID.",
            "readOnly":true
        },
        "status":{
            "type":"string",
            "description":"The status of the migration request.",
            "readOnly":true,
            "enum":[
                "TRAINING",
                "COMPLETED",
                "TERMINATED_BY_ERROR"
            ]
        },
        "statusMessage":{
            "type":"string",
            "description":"The message associated with the migration request.",
            "readOnly":true
        },
        "botId":{
            "type":"string",
            "description":"The target skill ID for the migration request.",
            "readOnly":true
        },
        "sourceBotId":{
            "type":"string",
            "description":"The source skill ID for the migration request.",
            "readOnly":true
        }
    },
    "description":"Dynamic Entities Migration Request"
}

Nested Schema : links

Type: array

Read Only: true

An array of links to the resource.

Show Source

• empty: boolean
• selfLinks: object selfLinks

{
    "type":"array",
    "properties":{
        "selfLinks":{
            "type":"object",
            "properties":{
                "absolutePathBuilder":{
                    "type":"object"
                },
                "baseUri":{
                    "type":"string",
                    "format":"uri"
                },
                "requestUri":{
                    "type":"string",
                    "format":"uri"
                },
                "requestUriBuilder":{
                    "type":"object"
                },
                "baseUriBuilder":{
                    "type":"object"
                },
                "pathParameters":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "queryParameters":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "matchedURIs":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "matchedResources":{
                    "type":"array",
                    "items":{
                        "type":"object"
                    }
                },
                "pathSegments":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "matrixParameters":{
                                "type":"object",
                                "additionalProperties":{
                                    "type":"array",
                                    "items":{
                                        "type":"string"
                                    }
                                }
                            },
                            "path":{
                                "type":"string"
                            }
                        }
                    }
                },
                "absolutePath":{
                    "type":"string",
                    "format":"uri"
                },
                "path":{
                    "type":"string"
                }
            },
            "writeOnly":true
        },
        "empty":{
            "type":"boolean"
        }
    },
    "description":"An array of links to the resource.",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Show Source

• Array of: object Link

{
    "type":"array",
    "properties":{
        "selfLinks":{
            "type":"object",
            "properties":{
                "absolutePathBuilder":{
                    "type":"object"
                },
                "baseUri":{
                    "type":"string",
                    "format":"uri"
                },
                "requestUri":{
                    "type":"string",
                    "format":"uri"
                },
                "requestUriBuilder":{
                    "type":"object"
                },
                "baseUriBuilder":{
                    "type":"object"
                },
                "pathParameters":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "queryParameters":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "matchedURIs":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "matchedResources":{
                    "type":"array",
                    "items":{
                        "type":"object"
                    }
                },
                "pathSegments":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "matrixParameters":{
                                "type":"object",
                                "additionalProperties":{
                                    "type":"array",
                                    "items":{
                                        "type":"string"
                                    }
                                }
                            },
                            "path":{
                                "type":"string"
                            }
                        }
                    }
                },
                "absolutePath":{
                    "type":"string",
                    "format":"uri"
                },
                "path":{
                    "type":"string"
                }
            },
            "writeOnly":true
        },
        "empty":{
            "type":"boolean"
        }
    },
    "description":"An array of links to the resource.",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : selfLinks

Type: object

Show Source

• absolutePath: string (uri)
• absolutePathBuilder: object absolutePathBuilder
• baseUri: string (uri)
• baseUriBuilder: object baseUriBuilder
• matchedResources: array matchedResources
• matchedURIs: array matchedURIs
• path: string
• pathParameters: object pathParameters
  Additional Properties Allowed: additionalProperties
• pathSegments: array pathSegments
• queryParameters: object queryParameters
  Additional Properties Allowed: additionalProperties
• requestUri: string (uri)
• requestUriBuilder: object requestUriBuilder

{
    "type":"object",
    "properties":{
        "absolutePathBuilder":{
            "type":"object"
        },
        "baseUri":{
            "type":"string",
            "format":"uri"
        },
        "requestUri":{
            "type":"string",
            "format":"uri"
        },
        "requestUriBuilder":{
            "type":"object"
        },
        "baseUriBuilder":{
            "type":"object"
        },
        "pathParameters":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "queryParameters":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "matchedURIs":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "matchedResources":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "pathSegments":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "matrixParameters":{
                        "type":"object",
                        "additionalProperties":{
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        }
                    },
                    "path":{
                        "type":"string"
                    }
                }
            }
        },
        "absolutePath":{
            "type":"string",
            "format":"uri"
        },
        "path":{
            "type":"string"
        }
    },
    "writeOnly":true
}

Nested Schema : Link

Type: object

Show Source

• href: string
  URL to the resource
• rel: string
  The relationship with the resource

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"The relationship with the resource"
        },
        "href":{
            "type":"string",
            "description":"URL to the resource"
        }
    }
}

Nested Schema : absolutePathBuilder

Type: object

Nested Schema : baseUriBuilder

Type: object

Nested Schema : matchedResources

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : matchedURIs

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : pathParameters

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : pathSegments

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "matrixParameters":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            },
            "path":{
                "type":"string"
            }
        }
    }
}

Nested Schema : queryParameters

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : requestUriBuilder

Type: object

Nested Schema : items

Type: object

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Show Source

• matrixParameters: object matrixParameters
  Additional Properties Allowed: additionalProperties
• path: string

{
    "type":"object",
    "properties":{
        "matrixParameters":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "path":{
            "type":"string"
        }
    }
}

Nested Schema : matrixParameters

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

400 Response

There was a problem with the request. Take action based on the error message.

Body ()

Root Schema : RestError

Type: object

Show Source

• detail: string
• instance: string
• o:ecid: string
• o:errorCode: string
• o:errorDetails: array o:errorDetails
• o:errorPath: string
• o:location: object Location
• o:opcRequestId: string
• status: integer (int32)
• title: string
• type: string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        },
        "instance":{
            "type":"string"
        },
        "o:ecid":{
            "type":"string"
        },
        "o:opcRequestId":{
            "type":"string"
        },
        "o:errorCode":{
            "type":"string"
        },
        "o:errorPath":{
            "type":"string"
        },
        "o:errorDetails":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RestError"
            }
        },
        "o:location":{
            "$ref":"#/components/schemas/Location"
        }
    }
}

Nested Schema : o:errorDetails

Type: array

Show Source

• Array of: object RestError

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RestError"
    }
}

Nested Schema : Location

Type: object

Show Source

• context: object Context
• o:colNo: integer (int32)
• o:lineNo: integer (int32)
• source: string

{
    "type":"object",
    "properties":{
        "source":{
            "type":"string"
        },
        "context":{
            "$ref":"#/components/schemas/Context"
        },
        "o:lineNo":{
            "type":"integer",
            "format":"int32"
        },
        "o:colNo":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : Context

Type: object

Show Source

• elementName: string
• elementType: string
  Allowed Values: [ "state", "defaultTransitionAction", "inputParameter", "outputParameter", "variable", "eventMapping", "intent", "entity" ]
• subElementName: string
• subElementType: string
  Allowed Values: [ "stateProperty", "componentProperty", "transition", "transitionAction", "property", "inputParameter", "outputParameter" ]

{
    "type":"object",
    "properties":{
        "elementType":{
            "type":"string",
            "enum":[
                "state",
                "defaultTransitionAction",
                "inputParameter",
                "outputParameter",
                "variable",
                "eventMapping",
                "intent",
                "entity"
            ]
        },
        "elementName":{
            "type":"string"
        },
        "subElementType":{
            "type":"string",
            "enum":[
                "stateProperty",
                "componentProperty",
                "transition",
                "transitionAction",
                "property",
                "inputParameter",
                "outputParameter"
            ]
        },
        "subElementName":{
            "type":"string"
        }
    }
}

404 Response

Can't create the migration request because either the source or the target skill doesn't exist.

Body ()

Root Schema : RestError

Type: object

Show Source

• detail: string
• instance: string
• o:ecid: string
• o:errorCode: string
• o:errorDetails: array o:errorDetails
• o:errorPath: string
• o:location: object Location
• o:opcRequestId: string
• status: integer (int32)
• title: string
• type: string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        },
        "instance":{
            "type":"string"
        },
        "o:ecid":{
            "type":"string"
        },
        "o:opcRequestId":{
            "type":"string"
        },
        "o:errorCode":{
            "type":"string"
        },
        "o:errorPath":{
            "type":"string"
        },
        "o:errorDetails":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RestError"
            }
        },
        "o:location":{
            "$ref":"#/components/schemas/Location"
        }
    }
}

Nested Schema : o:errorDetails

Type: array

Show Source

• Array of: object RestError

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RestError"
    }
}

Nested Schema : Location

Type: object

Show Source

• context: object Context
• o:colNo: integer (int32)
• o:lineNo: integer (int32)
• source: string

{
    "type":"object",
    "properties":{
        "source":{
            "type":"string"
        },
        "context":{
            "$ref":"#/components/schemas/Context"
        },
        "o:lineNo":{
            "type":"integer",
            "format":"int32"
        },
        "o:colNo":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : Context

Type: object

Show Source

• elementName: string
• elementType: string
  Allowed Values: [ "state", "defaultTransitionAction", "inputParameter", "outputParameter", "variable", "eventMapping", "intent", "entity" ]
• subElementName: string
• subElementType: string
  Allowed Values: [ "stateProperty", "componentProperty", "transition", "transitionAction", "property", "inputParameter", "outputParameter" ]

{
    "type":"object",
    "properties":{
        "elementType":{
            "type":"string",
            "enum":[
                "state",
                "defaultTransitionAction",
                "inputParameter",
                "outputParameter",
                "variable",
                "eventMapping",
                "intent",
                "entity"
            ]
        },
        "elementName":{
            "type":"string"
        },
        "subElementType":{
            "type":"string",
            "enum":[
                "stateProperty",
                "componentProperty",
                "transition",
                "transitionAction",
                "property",
                "inputParameter",
                "outputParameter"
            ]
        },
        "subElementName":{
            "type":"string"
        }
    }
}

412 Response

A push request for one of the affected entities in the target skill is already in progress.

Body ()

Root Schema : RestError

Type: object

Show Source

• detail: string
• instance: string
• o:ecid: string
• o:errorCode: string
• o:errorDetails: array o:errorDetails
• o:errorPath: string
• o:location: object Location
• o:opcRequestId: string
• status: integer (int32)
• title: string
• type: string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        },
        "instance":{
            "type":"string"
        },
        "o:ecid":{
            "type":"string"
        },
        "o:opcRequestId":{
            "type":"string"
        },
        "o:errorCode":{
            "type":"string"
        },
        "o:errorPath":{
            "type":"string"
        },
        "o:errorDetails":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RestError"
            }
        },
        "o:location":{
            "$ref":"#/components/schemas/Location"
        }
    }
}

Nested Schema : o:errorDetails

Type: array

Show Source

• Array of: object RestError

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RestError"
    }
}

Nested Schema : Location

Type: object

Show Source

• context: object Context
• o:colNo: integer (int32)
• o:lineNo: integer (int32)
• source: string

{
    "type":"object",
    "properties":{
        "source":{
            "type":"string"
        },
        "context":{
            "$ref":"#/components/schemas/Context"
        },
        "o:lineNo":{
            "type":"integer",
            "format":"int32"
        },
        "o:colNo":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : Context

Type: object

Show Source

• elementName: string
• elementType: string
  Allowed Values: [ "state", "defaultTransitionAction", "inputParameter", "outputParameter", "variable", "eventMapping", "intent", "entity" ]
• subElementName: string
• subElementType: string
  Allowed Values: [ "stateProperty", "componentProperty", "transition", "transitionAction", "property", "inputParameter", "outputParameter" ]

{
    "type":"object",
    "properties":{
        "elementType":{
            "type":"string",
            "enum":[
                "state",
                "defaultTransitionAction",
                "inputParameter",
                "outputParameter",
                "variable",
                "eventMapping",
                "intent",
                "entity"
            ]
        },
        "elementName":{
            "type":"string"
        },
        "subElementType":{
            "type":"string",
            "enum":[
                "stateProperty",
                "componentProperty",
                "transition",
                "transitionAction",
                "property",
                "inputParameter",
                "outputParameter"
            ]
        },
        "subElementName":{
            "type":"string"
        }
    }
}

Back to Top