Azure Connector Migration Tasks

Create Connector Migration Tasks

post/batchconnectormigrationtasks/azure

Create new Azure Connector Migration Tasks.

Related SDK Methods:

Java

([param1, param2, ...])

Python

([param1, param2, ...])

JavaScript

([param1, param2, ...])

Request

Security:

DefaultAuthentication

header Parameters

api-version

required

string

The version of the api being called.

Example: YOUR VERSION

Request Body schema: application/json

The task to migrate the connector.

connectorIDs

required

Array of integers <int32>

IDs of the Connector.

Responses

200

successful operation

400

Invalid parameters to create connector migration tasks

403

Not authorized to migrate Azure connector.

Request samples

Payload
Java
Python
JavaScript

application/json

{"connectorIDs": [0
]
}

Response samples

200

application/json

{"connectorMigrationTasks": [{"ID": 0,
"connectorID": 0,
"status": "requested",
"errorCode": 0,
"created": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z"
}
],
"connectorsUnableToMigrate": [{"connectorID": 0,
"errorMessage": "string"
}
]
}

Search Connector Migration Tasks

post/connectormigrationtasks/azure/search

Search for Azure connector migration task using optional filters.

Related SDK Methods:

Java

([param1, param2, ...])

Python

([param1, param2, ...])

JavaScript

([param1, param2, ...])

Request

Security:

DefaultAuthentication

header Parameters

api-version

required

string

The version of the api being called.

Example: YOUR VERSION

Request Body schema: application/json

A collection of options used to filter the search results.

maxItems	integer <int32> Limits the number of objects returned. Default 5000.
	Array of objects (searchCriteria) Array of search critiera used to filter objects. Searching with multiple criteria returns results that satisfy all of the criteria. Searching with no criteria returns all objects.
sortByObjectID	boolean If true, forces the response objects to be sorted by ID, overriding the default sort order. Default "false".

Responses

200

successful operation

403

Not authorized to migrate Azure connector.

Request samples

Payload
Java
Python
JavaScript

application/json

{"maxItems": 0,
"searchCriteria": [{"fieldName": "string",
"booleanTest": true,
"numericTest": "less-than",
"numericValue": 0,
"stringTest": "equal",
"stringValue": "string",
"stringWildcards": true,
"choiceTest": "equal",
"choiceValue": "string",
"firstDateValue": 0,
"firstDateInclusive": true,
"lastDateValue": 0,
"lastDateInclusive": true,
"nullTest": true,
"versionTest": "less-than",
"versionValue": "string",
"idValue": 0,
"idTest": "less-than"
}
],
"sortByObjectID": true
}

Response samples

200

application/json

{"connectorMigrationTasks": [{"ID": 0,
"connectorID": 0,
"status": "requested",
"errorCode": 0,
"created": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z"
}
]
}

Describe a Connector Migration Task

get/connectormigrationtasks/azure/{connectorMigrationTaskID}

Describe an Azure connector migration task.

Related SDK Methods:

Java

([param1, param2, ...])

Python

([param1, param2, ...])

JavaScript

([param1, param2, ...])

Request

Security:

DefaultAuthentication

path Parameters

connectorMigrationTaskID

required

integer <int64> \d+

The ID number of the connector migration task to describe.

Example: 1

header Parameters

api-version

required

string

The version of the api being called.

Example: YOUR VERSION

Responses

200

successful operation

403

Not authorized to migrate Azure connector.

Request samples

Java
Python
JavaScript

Response samples

200

application/json

{"ID": 0,
"connectorID": 0,
"status": "requested",
"errorCode": 0,
"created": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z"
}

List Connector Migration Tasks

get/connectormigrationtasks/azure

Describe Azure connector migration tasks.

Related SDK Methods:

Java

([param1, param2, ...])

Python

([param1, param2, ...])

JavaScript

([param1, param2, ...])

Request

Security:

DefaultAuthentication

header Parameters

api-version

required

string

The version of the api being called.

Example: YOUR VERSION

Responses

200

successful operation

403

Not authorized to migrate Azure connector.

Request samples

Java
Python
JavaScript

Response samples

200

application/json

{"connectorMigrationTasks": [{"ID": 0,
"connectorID": 0,
"status": "requested",
"errorCode": 0,
"created": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z"
}
]
}

Create a Connector Migration Task

post/connectormigrationtasks/azure

Create a new Azure Connector Migration Task.

Related SDK Methods:

Java

([param1, param2, ...])

Python

([param1, param2, ...])

JavaScript

([param1, param2, ...])

Request

Security:

DefaultAuthentication

header Parameters

api-version

required

string

The version of the api being called.

Example: YOUR VERSION

Request Body schema: application/json

The task to migrate the connector.

connectorID

integer <int32>

ID of the Connector.

Responses

200

successful operation

400

Invalid parameters to create a connector migration task

403

Not authorized to migrate Azure connector.

409

A connector migration task already exists

Request samples

Payload
Java
Python
JavaScript

application/json

{"connectorID": 0
}

Response samples

200

application/json

{"ID": 0,
"connectorID": 0,
"status": "requested",
"errorCode": 0,
"created": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z"
}