Manage orders - Get a New-Commerce migration schedule by ID
Gets a New-Commerce migration schedule entity.
GET https://api.partnercenter.microsoft.com/v{version}/customers/{customer_id}/migrations/newcommerce/schedules/{new_commerce_migration_schedule_id}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
customer_id
|
path | True |
string |
|
new_commerce_migration_schedule_id
|
path | True |
string |
|
version
|
path | True |
string |
Request Header
Name | Required | Type | Description |
---|---|---|---|
Authorization | True |
string |
Authorization Bearer Token |
MS-CorrelationId |
string |
Used for tracking requests internally. If a MS-CorrelationId is not provided, the server will generate a new one for each request |
|
MS-CV |
string |
Used for tracking requests internally. If a MS-CV is not provided, the server will generate a new one for each request |
|
MS-RequestId |
string |
Used for idempotency of requests. If a MS-RequestId is not provided, the server will generate a new one for each request |
Responses
Name | Type | Description |
---|---|---|
201 Created |
Microsoft. |
The request was successful. The response body contains the New-Commerce migration schedule entity. Media Types: "text/plain", "application/json", "text/json" |
400 Bad Request |
There was a missing or an invalid input. The response body will provide the error details. Media Types: "text/plain", "application/json", "text/json" |
|
401 Unauthorized |
The request was not authenticated. The client needs to authenticate with the partner API service first. Media Types: "text/plain", "application/json", "text/json" |
|
403 Forbidden |
The request was authenticated but was refused since the caller does not have the rights to invoke it. Media Types: "text/plain", "application/json", "text/json" |
|
404 Not Found |
The resource is not found or not available with the given input parameters. Media Types: "text/plain", "application/json", "text/json" |
|
500 Internal Server Error |
The partner API service or one of its dependencies failed to fulfill the request. Callers may retry this. Media Types: "text/plain", "application/json", "text/json" |
Definitions
Microsoft.Partner.Providers.Migration.V1.Models.NewCommerceMigrationSchedule
Name | Type | Description |
---|---|---|
addOnMigrationSchedules |
Microsoft. |
|
billingCycle |
string |
|
catalogItemId |
string |
|
createdTime |
string |
|
currentSubscriptionId |
string |
|
customTermEndDate |
string |
|
customerTenantId |
string |
|
errorCode |
integer |
|
errorDescription |
string |
|
externalReferenceId |
string |
|
id |
string |
|
isPartnerCreated |
boolean |
|
lastModifiedTime |
string |
|
microsoftLed |
boolean |
|
migrateOnRenewal |
boolean |
|
newCommerceMigrationId |
string |
|
purchaseFullTerm |
boolean |
|
quantity |
integer |
|
status |
string |
|
subscriptionEndDate |
string |
|
targetDate |
string |
|
termDuration |
string |