REST API References for Migration Services

This chapter provides examples for using REST API to discover migration services. It includes the following topics:

Using REST API with the Migration Schema Service

The Migration Schema Service migrates the physical Siebel schema from the source environment to the target environment.

The following table includes the methods supported for the Migration Schema Service.

Table Migration Schema Service Supported Methods

Method	Definition
Export	Method used to export a schema for a migration.
Import	Method used to import a schema for a migration.
GetWatermark	Method used to get a watermark for a migration.
IsSchemaChanged	Method used to check if a schema has changed for a migration.
GetStatus	Method used to get the status of a migration.

This topic includes the following topics:

Exporting with the Migration Schema Service

You can export a Migration Schema resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to export a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Schema Service/Export
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameter:
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.

Request body:

{
  "body":{
    "migrationid": "<Migration Id value>
  } 
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- trackingid: String that contains the tracking identification value.

Response body:

{
  "trackingid": "<tracking ID value>"
}

Getting Status with the Migration Schema Service

You can get status for a Migration Schema resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to get status for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Schema Service/GetStatus
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameters:
- trackingid: Contains the tracking identification value.
- getlog: If the value of this parameter is true, the log content of the resource along with the status is returned in the response. If the value is false, only the status is returned in the response.
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.

Request body:

{"body":{
  "trackingid": "<tracking Id value>",
  "getlog": "true"
  "migrationid": "<Migration Id value>
  }
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- status: Returns a value for the status of the request:
  - running: Indicates that the resource is running.
  - success: Indicates that the request was completed successfully.
  - error: Indicates that the request failed and the error parameter is populated with an error message.
- error: Returns an error message if an error is encountered.

Response body:

{
  "status": "success",
  "error": ""
}

Importing with the Migration Schema Service

You can import a Migration Schema resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to import a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Schema Service/Import
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameters:
- filename: Use the filename parameter to enter the name of the file to be imported.
- username: Use the user name parameter to enter your database user name.
- Use the password parameter to enter your database password.
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.

Request body:

{"body":{
  "filename": "<file name value>",
  "username":"<db username>",
  "password":"<db password>"
  "migrationid": "<Migration Id value>
  }
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- trackingid: Returns the tracking identification value.

Response body:

{  
  "trackingid": "<tracking id value>"
}

Verifying If a Schema Changed with the Migration Schema Service

You can check if a schema for a Migration Schema resource has changed by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to check if a schema has changed for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Schema Service/IsSchemaChanged
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameter:
- watermark: Use the watermark parameter to enter the watermark value.

Request body:

{ "body":
  { 
    "watermark": "<watermark value>"
  }
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- isschemachanged: Returns the value Y or N. Y indicated that the schema has changed. N indicates that the schema has not changed.
Response body:
```
{
  "isschemachanged": "Y"
}
```

Getting a Watermark with the Migration Schema Service

You can get a watermark for a Migration Schema resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to get a watermark for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Schema Service/GetWatermark
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request body:
```
{
  "body":{} 
}
```

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- watermark: Returns the watermark value.

Response body:

{
  "watermark": "<watermark value>" 
}

Using REST API with the Migration Design Repository Data Service

The Migration Design Repository Data Service migrates the design time repository and the runtime repository from the source environment to the target environment.

The following table includes the methods supported for the Migration Design Repository Data Service.

Table Migration Design Repository Data Service Supported Methods

Method	Definition
Export	Method used to export a schema for a migration.
Import	Method used to import a schema for a migration.
DBChck	Method used to check a database for a migration.
GetStatus	Method used to get the status of a migration.

This topic includes the following topics:

Exporting with the Migration Design Repository Data Service

You can export a Migration Design Repository Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to export a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Design Repository Data Service/Export
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameter:
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.

Request body:

{
  "body":{
    "migrationid": "<Migration Id value>
  } 
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- trackingid: Returns the tracking identification value.

Response body:

{  
  "trackingid": "<tracking id value>"
}

Checking a Database with the Migration Design Repository Data Service

You can check a database for a Migration Design Repository Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to get a database check for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Design Repository Data Service/DBCheck
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request body:
```
{
  "body":{} 
}
```

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- trackingid: Returns the tracking identification value.

Response body:

{ 
  "trackingid": "<tracking id value>"
}

Getting Status for a Migration Design Repository Data Service

You can get status for a Migration Design Repository Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to get status for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Design Repository Data Service/GetStatus
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameters:
- trackingid: Contains the tracking identification value.
- getlog: If the value of this parameter is true, the log content of the resource along with the status is returned in the response. If the value is false, only the status is returned in the response.
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.

Request body:

{
  "body":
  {
    "trackingid": "<tracking id value>",
    "migrationid": "<Migration Id value>
    "getlog":"true"
  }
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- status: Returns a value for the status of the request:
  - running: Indicates that the resource is running.
  - success: Indicates that the request was completed successfully.
  - error: Indicates that the request failed and the error parameter is populated with an error message.
- error: Returns an error message if an error is encountered.

Response body:

{
  "status": "success",
  "error": ""
}

Importing with the Migration Design Repository Data Service

You can import a Migration Design Repository Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to import a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Design Repository Data Service/Import
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameters:
- filename: Use the filename parameter to include the name of the file to be imported.
- migrationid: Use the migrationid string to include the migration identification value in the REST API request.

Request body:

{
  "body":
  {
    "filename": "<file name value>"
    "migrationid": "<Migration Id value>
  }
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- trackingid: Returns the tracking identification value.

Response body:

{  
  "trackingid": "<tracking id value>"
}

Using REST API with the Migration Application Data Service

The Migration Application Data Service migrates the data from the source environment to the target environment based on the tables listed in datamig.inp file on the source environment.

The following table includes the methods supported for the Migration Application Data Service.

Table Migration Application Data Service Supported Methods

Method	Definition
Export	Method used to export a schema for a migration.
Import	Method used to import a schema for a migration.
GetStatus	Method used to get the status of a migration.

This topic includes the following topics:

Exporting with the Migration Application Data Service

You can export a Migration Application Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to export a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Application Data Service/Export
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameters:
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.

Request body:

{
  "body":{

    "migrationid": "<Migration Id value>
  } 
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- trackingid: Returns the tracking identification value.

Response body:

{  
  "trackingid": "<tracking id value>"
}

Getting Status with the Migration Application Data Service

You can get status for a Migration Application Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to get status for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Application Data Service/GetStatus
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameters:
- trackingid: Contains the tracking identification value.
- getlog: If the value of this parameter is true, the log content of the resource along with the status is returned in the response. If the value is false, only the status is returned in the response.
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.

Request body:

{
  "body":
  {
    "trackingid": "<tracking id value>",
    "migrationid": "<Migration Id value>
    "getlog": "true"
  }
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- status: Returns a value for the status of the request:
  - running: Indicates that the resource is running.
  - success: Indicates that the request was completed successfully.
  - error: Indicates that the request failed and the error parameter is populated with an error message.
- error: Returns an error message if an error is encountered.

Response body:

{
  "status": "success",
  "error": ""
}

Importing with the Migration Application Data Service

You can import a Migration Application Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to import a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Application Data Service/Import
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameters:
- filename: Use the filename parameter to enter the name of the file to be imported.
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.

Request body:

{
  "body":
  {
    "filename": "<file name value>"
    "migrationid": "<Migration Id value>
  }
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- trackingid: Returns the tracking identification value.

Response body:

{
  "trackingid": "<tracking id value>"
}

Using REST API with the Migration Data Service with Transformation Service

The Migration Data Service with Transformation service migrates the data from the source environment to the target environment. based on the tables listed in the datamig.inp on the source environment.

While exporting the data, this service uses the rule defined in the datamig.rul file and performs the transformation. The transformed data will be migrated to the target environment.

The following table includes the methods supported for the Migration Data Service with Transformation Service.

Table Migration Data Service with Transformation Service Supported Methods

Method	Definition
Export	Method used to export a schema for a migration.
Import	Method used to import a schema for a migration.
GetStatus	Method used to get the status of a migration.

This topic includes the following topics:

Exporting with the Migration Application Data Service With Transformation

You can export a Migration Application Data Service With Transformation resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to export a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Application Data Service With Transformation/Export
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameter:
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.

Request body:

{
  "body":{
    "migrationid": "<Migration Id value>
  } 
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- trackingid: Returns the tracking identification value.

Response body:

{
"trackingid": "<tracking id value>"
}

Getting Status with the Migration Application Data Service With Transformation

You can get status for a Migration Application Data Service With Transformation resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to get status for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Application Data Service With Transformation/GetStatus
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameters:
- trackingid: Contains the tracking identification value.
- getlog: If the value of this parameter is true, the log content of the resource along with the status is returned in the response. If the value is false, only the status is returned in the response.
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.

Request body:

{
  "body":
  {
    "trackingid": "<tracking id value>",
    "migrationid": "<Migration Id value>
    "getlog": "true"
  }
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- status: Returns a value for the status of the request:
  - running: Indicates that the resource is running.
  - success: Indicates that the request was completed successfully.
  - error: Indicates that the request failed and the error parameter is populated with an error message.
- error: Returns an error message if an error is encountered.

Response body:

{
  "status": "success",
  "error": ""
}

Importing with the Migration Application Data Service With Transformation

You can import a Migration Application Data Service With Transformation resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to import a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Application Data Service With Transformation/Import
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameters:
- filename: Use the filename parameter to include the name of the file to be imported.
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.

Request body:

{
  "body":
  {
    "filename": "<filename value>"
    "migrationid": "<Migration Id>
  }
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- trackingid: Returns the tracking identification value.

Response body:

{
  "trackingid": "<tracking id value>"
}

Using REST API with the Migration Incremental Runtime Repository Data Service

The Migration Incremental Runtime Repository Data Service identifies the version of the repository data that was previously migrated. If you select the latest migration version, then this service takes the changes from the previous migration version and latest version and migrates the data to the target environment. If you do not make any selections, the service only considers the latest migration version and migrates the data to the target environment.

The following table includes the methods supported for the Migration Incremental Runtime Repository Data Service.

Table Migration Incremental Runtime Repository Data Service Supported Methods

Method	Definition
Export	Method used to export a schema for a migration.
Import	Method used to import a schema for a migration.
GetWatermark	Method used to get a watermark for a migration.
DBCheck	Method used to check a database has for a migration.
GetStatus	Method used to get the status of a migration.

This topic includes the following topics:

Getting a Watermark with the Migration Incremental Runtime Repository Data Service

You can get a watermark for a Migration Incremental Runtime Repository Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to get a watermark for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Incremental Runtime Repository Data Service/GetWatermark
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request body:
```
{
  "body":{} 
}
```

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- watermark: Returns the watermark value.
Response body:
```
{
  "watermark": "<watermark value>"
}
```

Exporting with the Migration Incremental Runtime Repository Data Service

You can export a Migration Incremental Runtime Repository Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to export a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Incremental Runtime Repository Data Service/Export
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameters:
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.
- watermark: Use the watermark parameter to include the watermark value.

Request body:

{
  "body":
    "migrationid": "<Migration Id value>
  {
    "watermark": "<watermark value>"
  }
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- trackingid: Returns the tracking identification value.

Response body:

{
"trackingid": "<tracking id value>"
}

Getting Status with the Migration Incremental Runtime Repository Data Service

You can get status for a Migration Incremental Runtime Repository Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to get status for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/ Migration Incremental Runtime Repository Data Service/GetStatus
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameters:
- trackingid: Contains the tracking identification value.
- getlog: If the value of this parameter is true, the log content of the resource along with the status is returned in the response. If the value is false, only the status is returned in the response.
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.

Request body:

{
"body":
  {
    "trackingid": "<tracking id value>",
    "migrationid", "<Migration Id value>"
    "getlog": "true"
  }
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- status: Returns a value for the status of the request:
  - running: Indicates that the resource is running.
  - success: Indicates that the request was completed successfully.
  - error: Indicates that the request failed and the error parameter is populated with an error message.
- error: Returns an error message if an error is encountered.

Response body:

{
  "status": "success",
  "error": ""
}

Importing with the Migration Incremental Runtime Repository Data Service

You can import a Migration Incremental Runtime Repository Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to import a resource:

URI: http://<host>:<port>/siebel/v1.0/service/ Migration Incremental Runtime Repository Data Service/Import
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameters:
- filename: Use the filename parameter to include the name of the file to be imported.
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.

Request body:

{
"body":
  {
    "filename": "<file name value>"
    "migrationid", "<Migration Id value>"
  }
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- trackingid: Returns the tracking identification value.

Response body:

{
"trackingid": "<tracking id value>"
}

Checking a Database with the Migration Incremental Runtime Repository Data Service

You can check a database for a Migration Incremental Runtime Repository Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to check a database for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/ Migration Incremental Runtime Repository Data Service/DBCheck
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request body:
```
{
  "body":{} 
}
```

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- trackingid: Returns the tracking identification value.

Response body:

{
"trackingid": "<tracking id value>"
}

Activating the Workflow and Taskflow with the Migration Incremental Runtime Repository Data Service

You can activate the workflow and taskflow after importing the incremental runtime repository by sending an HTTP POST request to the repository resource's URL.

The following details are for a request to activate the workflow and taskflow for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Runtime Repository Data Service/ActivateWorkflowsTasks
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request body:
```
{
  "body":{} 
}
```

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- status: Returns a value for the status of the request:
  - running: Indicates that the resource is running.
  - success: Indicates that the request was completed successfully.
  - error: Indicates that the request failed and the error parameter is populated with an error message.
Response body:
```
{
“status:success
}
```

Using REST API with the Migration Runtime Repository Data Service

The Migration Runtime Repository Data Service migrates only the runtime repository from the source environment to the target environment.

The following table includes the methods supported for the Migration Runtime Repository Data Service.

Table Migration Runtime Repository Data Service Supported Methods

Method	Definition
Export	Method used to export a schema for a migration.
Import	Method used to import a schema for a migration.
GetWatermark	Method used to get a watermark for a migration.
DBCheck	Method used to check a database for a migration.
GetStatus	Method used to get the status of a migration.
GetRRInfo	Method used to get Runtime Repository information.

This topic includes the following topics:

Getting Runtime Repository Information with the Migration Runtime Repository Data Service

You can get runtime repository information for a Migration Runtime Repository Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to get runtime repository information for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Runtime Repository Data Service/GetRRInfo
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request body:
```
{
  "body":{} 
}
```

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- workspace: Returns the name of the workspace branch, the latest version of the workspace branch, and workspace languages. If there are multiple workspace branches in the Siebel environment, then the branch name and its latest version will be separated by a comma in the response. The response lists all the Siebel environment languages. If there is only one language, then only one language is listed in the response.

Response body:

{ 
  "workspace": 
  { 
    "Branch Name": "Last Version Number of the Branch" 
  }, 
    "languages": 
    {...
    } 
}

Getting a Watermark with the Migration Runtime Repository Data Service

You can get a water mark for a Migration Runtime Repository Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to get a watermark for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Runtime Repository Data Service/GetWaterMark
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameters:
- workspace: Use the workspace parameter to enter the name of the workspace branch in the REST API request.
- version: Use the version parameter to enter the version number of the workspace branch. The value is 0 to the latest version of the specified workspace branch.

Request body:

{
  "body":
  { 
    "workspace":"<workspace branch name>", 
    "version":"<version>",
  } 
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- watermark: Returns the watermark value.

Response body:

{ 
  "watermark": "<Watermark value>" 
}

Exporting with the Migration Runtime Repository Data Service

You can export a Migration Runtime Repository Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to export a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Runtime Repository Data Service/Export
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameters:
- watermark: Use the watermark parameter to include the name of the watermark in the REST API request.
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.

Request body:

{
  "body":
  { 
    "watermark": "<Watermark value>" 
    "migrationid", "<Migration Id value>"
  }
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- trackingid: Returns the tracking identification value.

Response body:

{ 
  "trackingid": "<tracking id value>" 
}

Getting Status with the Migration Runtime Repository Data Service

You can get status for a Migration Runtime Repository Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to get status for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Runtime Repository Data Service/GetStatus
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameters:
- trackingid: Contains the tracking identification value.
- getlog: If the value of this parameter is true, the log content of the resource along with the status is returned in the response. If the value is false, only the status is returned in the response.
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.

Request body:

{
  "body":
  { 
    "trackingid":"<tracking id value>", 
    "migrationid", "<Migration Id value>"
    "getlog":"TRUE" 
}
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- status: Returns a value for the status of the request:
  - running: Indicates that the resource is running.
  - success: Indicates that the request was completed successfully.
  - error: Indicates that the request failed and the error parameter is populated with an error message.
- error: Returns an error message if an error is encountered.
- log: Returns log file content if the getlog parameter value is set to TRUE.

Response body:

{
  "status": "success", 
  "error": "", 
  "log": <log file content> 
}

Importing with the Migration Runtime Repository Data Service

You can import a Migration Runtime Repository Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to import a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Runtime Repository Data Service/Import
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameters:
- filename: Use the filename parameter to enter the name of the file to be imported.
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.

Request body:

{
  "body":
  { 
    "filename":"<file name value>", 
    "migrationid", "<Migration Id value>"
  } 
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- trackingid: String that contains the tracking identification value.

Response body:

{ 
  "trackingid": "<tracking id value>" 
}

Checking a Database with the Migration Runtime Repository Data Service

You can check a database for a Migration Runtime Repository Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to check a database for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Runtime Repository Data Service/DBCheck
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request body:
```
{
  "body":{} 
}
```

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- trackingid: Returns the tracking identification value.

Response body:

{
"trackingid": "<tracking id value>"
}

Using REST API with the Migration Incremental Application Workspace Data Service

The Migration Incremental Application Workspace Data Service identifies the version that was previously migrated. This service takes all the changes from the previously migrated version to the latest version and migrates them to the target environment.

The following table includes the methods supported for the Migration Incremental Application Workplace Data Service.

Table Migration Incremental Application Workspace Data Service Supported Methods

Method	Definition
Export	Method used to export a schema for a migration.
Import	Method used to import a schema for a migration.
GetWatermark	Method used to get a watermark for a migration.
GetStatus	Method used to get the status of a migration.

This topic includes the following topics:

Getting Status with the Migration Incremental Application Workspace Data Service

You can get status for a Migration Incremental Application Workspace Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to get status for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Incremental Application Workspace Data Service/GetStatus
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameters:
- trackingid: Contains the tracking identification value.
- getlog: If the value of this parameter is true, the log content of the resource along with the status is returned in the response. If the value is false, only the status is returned in the response.
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.

Request body:

{
  "body":
  { 
    "trackingid":"<tracking id value>",
    "migrationid", "<Migration Id value>"
    "getlog":"TRUE" 
  }
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- status: Returns a value for the status of the request:
  - running: Indicates that the resource is running.
  - success: Indicates that the request was completed successfully.
  - error: Indicates that the request failed and the error parameter is populated with an error message.
- error: Returns an error message if an error is encountered.
- log: Return log file content if the getlog parameter is set to TRUE.

Response body:

{ 
"status": "success", 
"error": "", 
"log": log file content 
}

Getting a Watermark with the Migration Incremental Application Workspace Data Service

You can get a watermark for a Migration Incremental Application Workspace Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to get a watermark for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Incremental Application Workspace Data Service/GetWaterMark
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request body:
```
{
  "body":{} 
}
```

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- watermark: Returns the watermark value.
Response body:
```
{ 
  "watermark": "watermark value" 
}
```

Exporting with the Migration Incremental Application Workspace Data Service

You can export a Migration Incremental Application Workspace Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to export a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Incremental Application Workspace Data Service/Export
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameters:
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.
- watermark: Use the watermark parameter to include the watermark value in the REST API request.

Request body:

{
  "body":
    "migrationid", "<Migration Id value>"
  { 
    "watermark": "<watermark value>" 
  } 
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- trackingid: Returns the tracking identification value.

Response body:

{
"trackingid": "<tracking id value>"
}

Importing with the Migration Incremental Application Workspace Data Service

You can import a Migration Incremental Application Workspace Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to import a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Incremental Application Workspace Data Service/Import
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameters:
- filename: Use the filename parameter to include the name of the file to be imported.
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.

Request body:

{
  "body":
  {
    "filename": "<file name value>"
    "migrationid", "<Migration Id value>"
  }
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- trackingid: Returns the tracking identification value.

Response body:

{
"trackingid": "<tracking id value>"
}

Invalidating Seed Caches with the Migration Incremental Application Workspace Data service

You can invalidate seed caches for a Migration Incremental Application Workspace Data service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to invalidate seed caches for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Incremental Application Workspace Data service/InvalidateSeedCaches
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request body:
```
{
  "body":{} 
}
```

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- status: Returns a value for the status of the request:
  - running: Indicates that the resource is running.
  - success: Indicates that the request was completed successfully.
  - error: Indicates that the request failed and the error parameter is populated with an error message.
Response body:
```
{
  "status": "success"
}
```

Using REST API with Migration Application Workspace Data Service

The Migration Application Workspace Data Service migrates the seed records from the source environment to the target environment.

The following table includes the methods supported for the Migration Application Workspace Data Service.

Table Migration Application Workspace Data Service Supported Methods

Method	Definition
GetSeedCopyWatermark	Method used to get the seed copy watermark for a migration.
GetFullSeedWatermark	Method used to get a full seed watermark for a migration.
SeedCopyExport	Method used to export a copy of seed data for a migration.
SeedCopyImport	Method used import a copy of seed data for a migration.
FullSeedExport	Method used to export full seed data for a migration.
FullSeedImport	Method used to import full seed data for a migration.
GetStatus	Method used to get the status of a migration.

This topic includes the following topics:

Getting a Seed Copy Watermark with the Migration Application Workspace Data Service

You can get a seed copy watermark for a Migration Application Workspace Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to get a seed copy watermark for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Application Workspace Data Service/GetSeedCopyWatermark
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request body:
```
{
  "body":{} 
}
```

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- watermark: Returns the watermark value.
Response body:
```
{
"watermark": "<Watermark value>"
}
```

Getting the Full Seed Watermark with the Migration Application Workspace Data Service

You can get the full seed watermark for a Migration Application Workspace Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to get the full seed watermark for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Application Workspace Data Service/GetFullSeedWatermark
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request body:
```
{
  "body":{} 
}
```

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- watermark: Returns the watermark value.
Response body:
```
{
"watermark": "<Watermark value>"
}
```

Getting Status with the Migration Application Workspace Data Service

You can get status for a Migration Application Workspace Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to get status for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Application Workspace Data Service/GetStatus
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameters:
- trackingid: Contains the tracking identification value.
- getlog: If the value of this parameter is true, the log content of the resource along with the status is returned in the response. If the value is false, only the status is returned in the response.
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.

Request body:

{
  body": 
  {
    "trackingid":"<tracking id value>"
    "migrationid", "<Migration Id value>"
    "getlog":"TRUE"
  } 
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- status: Returns a value for the status of the request:
  - running: Indicates that the resource is running.
  - success: Indicates that the request was completed successfully.
  - error: Indicates that the request failed and the error parameter is populated with an error message.
- error: Returns an error message if an error is encountered.
- log: Returns log file content if the getlog parameter value is set to TRUE.

Response body:

{
"status": "success",
"error": "",
"log": "log file content
}

Getting a Seed Copy Export with the Migration Application Workspace Data Service

You can get a seed copy export for a Migration Application Workspace Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to get a seed copy export for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Application Workspace Data Service/SeedCopyExport
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameters:
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.
- watermark: Use the watermark parameter to include the watermark value in the REST API request.

Request body:

{
  "body": 
    "migrationid", "<Migration Id value>"
  {
    "watermark": "<Watermark value>"
  } 
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- trackingid: Returns the tracking identification value.

Response body:

{
  "trackingid": "<tracking id value>"
}

Getting a Seed Copy Import with the Migration Application Workspace Data Service

You can get a seed copy import for a Migration Application Workspace Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to get a seed copy import for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Application Workspace Data Service/SeedCopyImport
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameters:
- filename: Use the filename parameter to include the name of the file to be imported.
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.

Request body:

{
  "body": 
  {
    "filename":"<file name value>"
    "migrationid", "<Migration Id value>"
  } 
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- trackingid: Returns the tracking identification value.

Response body:

{
  "trackingid": "<tracking id value>"
}

Getting the Full Seed Export with the Migration Application Workspace Data Service

You can get a full seed export for a Migration Application Workspace Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to get a full seed export for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Application Workspace Data Service/FullSeedExport
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameters:
- watermark: Use the watermark parameter to include the watermark value in the REST API request.
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.

Request body:

{
  "body": 
    "migrationid", "<Migration Id value>"
  {
    "watermark": "<watermark value>"
  } 
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- trackingid: Returns the tracking identification value.

Response body:

{
  "trackingid": "<tracking id value>"
}

Getting the Full Seed Import with the Migration Application Workspace Data Service

You can get full seed import for a Migration Application Workspace Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to get full seed import for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Application Workspace Data Service/FullSeedImport
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request parameters:
- filename: Use the filename parameter to include the name of the file to be imported.
- migrationid: Use the migrationid parameter to include the migration identification value in the REST API request.

Request body:

{
"body": 
  {
    "filename":"<file name value>"
    "migrationid", "<Migration Id value>"
  } 
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
- trackingid: Returns the tracking identification value.

Response body:

{
  "trackingid": "<tracking id value>"
}

Invalidating the Seed Caches with the Migration Application Workspace Data Service

You can invalidate seed caches for a Migration Application Workspace Data Service resource by sending an HTTP POST request to the repository resource's URI.

The following details are for a request to invalidate seed caches for a resource:

URI: http://<host>:<port>/siebel/v1.0/service/Migration Application Workspace Data Service/InvalidateSeedCaches
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
Request body:
```
{
  "body":{} 
}
```

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response parameters:
Response body:
```
{
"status": "success"
}
```

Using REST API with the Siebel Migration Application

You can use REST APIs both before and after the repository upgrade is done. Use the asynchronous migration feature only if both source (development) and target (production) environments are in a Repository Upgraded state. If either (source or target) environment is not in a Repository Upgraded state, then the migration execution will be performed in synchronous mode.

You can use REST API with Siebel Migration Application to do the following:

Work with connections. You can use REST APIs to create connections, update your existing connection, get information about connections, generate a watermark for your connection, and delete your connection.
Work with migration plans. You can use REST APIs to create migration plans, update migration plans, get information about migration plans, and delete migration plans.
Execute migration plans. You can use REST APIs to execute migration plans and get status about your running migration plans by plan name, resource name, and operation. You can also get the log file based on an operation for a running migration plan.
Get history information about migration plans. You can use REST APIs to get history information about your migration plans by ID, resource name, plan name, and operation. You can also get the log file based on an operation for a particular history record.

This topic contains the following topics:

Using REST API to Configure Siebel Migration Application Connections

You can use the Siebel Migration REST API to configure connections for your migration plan.

This topic includes the following topics:

Getting All Connections

You can get all connections for your migration by sending an HTTP GET request to the Siebel Migration Application.

The following details are for a request to get all connections for a migration:

URI: https://{hostname}:{port}/siebel/v1.0/migration/connection
HTTP Method: GET
Content-Type: application/json
Authorization: Basic

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json

Response body:

[
 {  
      "id":"88-1V5WJZ",
      "name":"Dev",
      "restEndpoint":"https://{hostname}:{port}/siebel/v1.0",
      "isFavourite":"false",
      "uri":"https://{hostname}:{port}/siebel/v1.0",
      "connectionId":"88-1V5WJZ",
      "resources":[
 {  
            "id":"88-1V5WK0",
            "name":"Migration Schema Service",
            "displayName":"Schema Service",
            "type":"DB Util"
         },
         {  
            "id":"88-1V5WK1",
            "name":"Migration Design Repository Data Service",
            "displayName":"Design Repository Data Service",
            "type":"DB Util"
         },
         {  
            "id":"88-1V5WK2",
            "name":"Migration Runtime Repository Data Service",
            "displayName":"Runtime Repository Data Service",
            "type":"DB Util"
         },
         {  
            "id":"88-1V5WK3",
            "name":"Migration Application Workspace Data Service",
            "displayName":"Application Workspace Data Service",
            "type":"DB Util"
         },
         {  
            "id":"88-1V5WK4",
            "name":"Migration Incremental Runtime Repository Data Service",
            "displayName":"Incremental Runtime Repository Data Service",
            "type":"DB Util"
         },
         {  
            "id":"88-1V5WK5",
            "name":"Migration Incremental Application Workspace Data Service",
            "displayName":"Incremental Application Workspace Data Service",
            "type":"DB Util"
         },
         {  
            "id":"88-1V5WK6",
            "name":"Migration Application Data Service",
            "displayName":"Application Data Service",
            "type":"DB Util"
         },
         {  
            "id":"88-1V5WK7",
            "name":"Migration Application Data Service With Transformation",
            "displayName":"Application Data Service With Transformation",
            "type":"DB Util"
         },
         {  
            "id":"88-1V5WK8",
            "name":"MigrationFilePrepareAndDeploy",
            "displayName":"File Prepare And Deploy",
            "type":"DB Util"
         },
         {  
            "id":"88-1V5WK9",
            "name":"FINS BIB",
            "displayName":"FINS BIB",
            "type":"ADM"
         }
      ]
   },
   {  
      "id":"88-1V5WLD",
      "name":"Prod",
      "restEndpoint":"https://slc07fnj.us.oracle.com:16690/siebel/v1.0",
      "isFavourite":"false",
      "uri":"https://slc07fnj.us.oracle.com:16690/siebel/v1.0",
      "connectionId":"88-1V5WLD",
      "resources":[  
         {  
            "id":"88-1V5WLE",
            "name":"Migration Schema Service",
            "displayName":"Schema Service",
            "type":"DB Util"
         },
         {  
            "id":"88-1V5WLF",
            "name":"Migration Design Repository Data Service",
            "displayName":"Design Repository Data Service",
            "type":"DB Util"
         },
         {  
            "id":"88-1V5WLG",
            "name":"Migration Runtime Repository Data Service",
            "displayName":"Runtime Repository Data Service",
            "type":"DB Util"
         },
         {  
            "id":"88-1V5WLH",
            "name":"Migration Application Workspace Data Service",
            "displayName":"Application Workspace Data Service",
            "type":"DB Util"
         },
         {  
            "id":"88-1V5WLI",
            "name":"Migration Incremental Runtime Repository Data Service",
            "displayName":"Incremental Runtime Repository Data Service",
            "type":"DB Util"
         },
         {  
            "id":"88-1V5WLJ",
            "name":"Migration Incremental Application Workspace Data Service",
            "displayName":"Incremental Application Workspace Data Service",
            "type":"DB Util"
         },
         {  
            "id":"88-1V5WLK",
            "name":"Migration Application Data Service",
            "displayName":"Application Data Service",
            "type":"DB Util"
         },
         {  
            "id":"88-1V5WLL",
            "name":"Migration Application Data Service With Transformation",
            "displayName":"Application Data Service With Transformation",
            "type":"DB Util"
         },
         {  
            "id":"88-1V5WLM",
            "name":"MigrationFilePrepareAndDeploy",
            "displayName":"File Prepare And Deploy",
            "type":"DB Util"
         },
         {  
            "id":"88-1V5WLN",
            "name":"FINS BIB",
            "displayName":"FINS BIB",
            "type":"ADM"
         }
      ]
   }
]

Getting a Connection by Name

You can get a connection for your migration by sending an HTTP GET request to the Siebel Migration Application.

The following details are for a request to get a connection by name for a migration:

URI: https://{hostname}:{port}/siebel/v1.0/migration/connection/{connectionName}
HTTP Method: GET
Content-Type: application/json
Authorization: Basic

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json

Response body:

{  
   "id":"88-1V5WLD",
   "name":"Prod",
   "restEndpoint":"https://slc07fnj.us.oracle.com:16690/siebel/v1.0",
   "isFavourite":"false",
   "uri":"https://slc07fnj.us.oracle.com:16690/siebel/v1.0",
   "connectionId":"88-1V5WLD",
   "resources":[  
      {  
         "id":"88-1V5WLE",
         "name":"Migration Schema Service",
         "displayName":"Schema Service",
         "type":"DB Util"
      },
      {  
         "id":"88-1V5WLF",
         "name":"Migration Design Repository Data Service",
         "displayName":"Design Repository Data Service",
         "type":"DB Util"
      },
      {  
         "id":"88-1V5WLG",
         "name":"Migration Runtime Repository Data Service",
         "displayName":"Runtime Repository Data Service",
         "type":"DB Util"
      },
      {  
         "id":"88-1V5WLH",
         "name":"Migration Application Workspace Data Service",
         "displayName":"Application Workspace Data Service",
         "type":"DB Util"
      },
      {  
         "id":"88-1V5WLI",
         "name":"Migration Incremental Runtime Repository Data Service",
         "displayName":"Incremental Runtime Repository Data Service",
         "type":"DB Util"
      },
      {  
         "id":"88-1V5WLJ",
         "name":"Migration Incremental Application Workspace Data Service",
         "displayName":"Incremental Application Workspace Data Service",
         "type":"DB Util"
      },
      {  
         "id":"88-1V5WLK",
         "name":"Migration Application Data Service",
         "displayName":"Application Data Service",
         "type":"DB Util"
      },
      {  
         "id":"88-1V5WLL",
         "name":"Migration Application Data Service With Transformation",
         "displayName":"Application Data Service With Transformation",
         "type":"DB Util"
      },
      {  
         "id":"88-1V5WLM",
         "name":"MigrationFilePrepareAndDeploy",
         "displayName":"File Prepare And Deploy",
         "type":"DB Util"
      },
      {  
         "id":"88-1V5WLN",
         "name":"FINS BIB",
         "displayName":"FINS BIB",
         "type":"ADM"
      }
   ]
}

Creating a New Connection

You can create a new connection for your migration by sending an HTTP POST request to the Siebel Migration Application.

The following details are for a request to create a new connection for a migration:

URI: https://{hostname}:{port}/siebel/v1.0/migration/connection
HTTP Method: POST
Content-Type: application/json
Authorization: Basic

Request Body:

{
   "name":"Demo Source",
   "restEndpoint":"https://{hostname}:{port}/siebel/v1.0",
   "isFavourite":"true"
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json

Response Body:

{
   "id":"88-1V5ZL2",
   "name":"Demo Source",
   "restEndpoint":"https://{hostname}:{port}/siebel/v1.0",
   "isFavourite":"false",
   "resources":[
      {
         "id":"88-1V5ZL3",
         "name":"Migration Schema Service",
         "displayName":"Schema Service",
         "type":"DB Util"
      },
      {
         "id":"88-1V5ZL4",
         "name":"Migration Design Repository Data Service",
         "displayName":"Design Repository Data Service",
         "type":"DB Util"
      },
      {
         "id":"88-1V5ZL5",
         "name":"Migration Runtime Repository Data Service",
         "displayName":"Runtime Repository Data Service",
         "type":"DB Util"
      },
      {
         "id":"88-1V5ZL6",
         "name":"Migration Application Workspace Data Service",
         "displayName":"Application Workspace Data Service",
         "type":"DB Util"
      },
      {
         "id":"88-1V5ZL7",
         "name":"Migration Incremental Runtime Repository Data Service",
         "displayName":"Incremental Runtime Repository Data Service",
         "type":"DB Util"
      },
      {
         "id":"88-1V5ZL8",
         "name":"Migration Incremental Application Workspace Data Service",
         "displayName":"Incremental Application Workspace Data Service",
         "type":"DB Util"
      },
      {
         "id":"88-1V5ZL9",
         "name":"Migration Application Data Service",
         "displayName":"Application Data Service",
         "type":"DB Util"
      },
      {
         "id":"88-1V5ZLA",
         "name":"Migration Application Data Service With Transformation",
         "displayName":"Application Data Service With Transformation",
         "type":"DB Util"
      },
      {
         "id":"88-1V5ZLB",
         "name":"MigrationFilePrepareAndDeploy",
         "displayName":"File Prepare And Deploy",
         "type":"DB Util"
      },
      {
         "id":"88-1V5ZLC",
         "name":"FINS BIB",
         "displayName":"FINS BIB",
         "type":"ADM"
      }
   ]
}

Creating a Watermark for a Connection

You can create a watermark for your migration connection by sending an HTTP POST request to the Siebel Migration Application.

The following details are for a request to create a watermark for a migration connection:

URI: https://{hostname}:{port}/siebel/v1.0/migration/connection/{connectionName}/watermark
HTTP Method: POST
Content-Type: application/json
Authorization: Basic
R equest Body:
```
{
   "fileName":"demo.txt"
}
```

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json

Response Body:

{
   "watermarkFile":"c:\\fs\\migration\\demo.txt"
}

Updating the Connection

You can update a connection for your migration by sending an HTTP PUT request to the Siebel Migration Application.

The following details are for a request to update a connection for a migration:

URI: https://{hostname}:{port}/siebel/v1.0/migration/connection/{connectionName}
HTTP Method: PUT
Content-Type: application/json
Authorization: Basic

Request Body:

{
   "name":"Demo Dev",
   "restEndpoint":"https://{hostname}:{port}/siebel/v1.0",
   "isFavourite":"true"
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json

Response Body:

{
   "id":"88-1V5ZL2",
   "name":"Demo Dev",
   "restEndpoint":"https://slc04ovj.us.oracle.com:5021/siebel/v1.0",
   "isFavourite":"true",
   "resources":[
      {
         "id":"88-1V5ZL3",
         "name":"Migration Schema Service",
         "displayName":"Schema Service",
         "type":"DB Util"
      },
      {
         "id":"88-1V5ZL4",
         "name":"Migration Design Repository Data Service",
         "displayName":"Design Repository Data Service",
         "type":"DB Util"
      },
      {
         "id":"88-1V5ZL5",
         "name":"Migration Runtime Repository Data Service",
         "displayName":"Runtime Repository Data Service",
         "type":"DB Util"
      },
      {
         "id":"88-1V5ZL6",
         "name":"Migration Application Workspace Data Service",
         "displayName":"Application Workspace Data Service",
         "type":"DB Util"
      },
      {
         "id":"88-1V5ZL7",
         "name":"Migration Incremental Runtime Repository Data Service",
         "displayName":"Incremental Runtime Repository Data Service",
         "type":"DB Util"
      },
      {
         "id":"88-1V5ZL8",
         "name":"Migration Incremental Application Workspace Data Service",
         "displayName":"Incremental Application Workspace Data Service",
         "type":"DB Util"
      },
      {
         "id":"88-1V5ZL9",
         "name":"Migration Application Data Service",
         "displayName":"Application Data Service",
         "type":"DB Util"
      },
      {
         "id":"88-1V5ZLA",
         "name":"Migration Application Data Service With Transformation",
         "displayName":"Application Data Service With Transformation",
         "type":"DB Util"
      },
      {
         "id":"88-1V5ZLB",
         "name":"MigrationFilePrepareAndDeploy",
         "displayName":"File Prepare And Deploy",
         "type":"DB Util"
      },
      {
         "id":"88-1V5ZLC",
         "name":"FINS BIB",
         "displayName":"FINS BIB",
         "type":"ADM"
      }
   ]
}

Deleting a Connection

You can delete a migration connection by sending an HTTP DELETE request to the Siebel Migration Application.

The following details are for a request to delete a migration connection:

URI: https://{hostname}:{port}/siebel/v1.0/migration/connection/{connectionName}
HTTP Method: DELETE
Content-Type: application/json
Authorization: Basic

Using REST API to Configure Siebel Migration Application Migration Plans

You can use the Siebel Migration REST API to configure your migration plan.

This topic includes the following topics:

Getting All Migration Plans

You can get all migration plans for your migration by sending an HTTP GET request to the Siebel Migration Application.

The following details are for a request to get all migration plans for a migration:

URI: https://{hostname}:{port}/siebel/v1.0/migration/plan
HTTP Method: GET
Content-Type: application/json
Authorization: Basic

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json

Response Body:

[  
   {  
      "id":"88-1V5WMR",
      "name":"IRRMigration",
      "description":"IRRMigration",
      "source":"Dev",
      "target":"Prod",
      "resources":[  
         {  
            "id":"88-1V5WMS",
            "name":"Migration Schema Service",
            "displayName":"Schema Service",
            "isSelected":"true",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5WMT",
            "name":"Migration Design Repository Data Service",
            "displayName":"Design Repository Data Service",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5WMU",
            "name":"Migration Runtime Repository Data Service",
            "displayName":"Runtime Repository Data Service",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5WMV",
            "name":"Migration Application Workspace Data Service",
            "displayName":"Application Workspace Data Service",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5WMW",
            "name":"Migration Incremental Runtime Repository Data Service",
            "displayName":"Incremental Runtime Repository Data Service",
            "isSelected":"true",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5WMX",
            "name":"Migration Incremental Application Workspace Data Service",
            "displayName":"Incremental Application Workspace Data Service",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5WMY",
            "name":"Migration Application Data Service",
            "displayName":"Application Data Service",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5WMZ",
            "name":"Migration Application Data Service With Transformation",
            "displayName":"Application Data Service With Transformation",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5WN0",
            "name":"MigrationFilePrepareAndDeploy",
            "displayName":"File Prepare And Deploy",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5WN1",
            "name":"FINS BIB",
            "displayName":"FINS BIB",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         }
      ]
   },
   {  
      "id":"88-1V5Y2U",
      "name":"Data Mig",
      "description":"Data Mig",
      "source":"Dev",
      "target":"Prod",
      "resources":[  
         {  
            "id":"88-1V5Y2V",
            "name":"Migration Schema Service",
            "displayName":"Schema Service",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5Y2W",
            "name":"Migration Design Repository Data Service",
            "displayName":"Design Repository Data Service",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5Y2X",
            "name":"Migration Runtime Repository Data Service",
            "displayName":"Runtime Repository Data Service",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5Y2Y",
            "name":"Migration Application Workspace Data Service",
            "displayName":"Application Workspace Data Service",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5Y2Z",
            "name":"Migration Incremental Runtime Repository Data Service",
            "displayName":"Incremental Runtime Repository Data Service",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5Y30",
            "name":"Migration Incremental Application Workspace Data Service",
            "displayName":"Incremental Application Workspace Data Service",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5Y31",
            "name":"Migration Application Data Service",
            "displayName":"Application Data Service",
            "isSelected":"true",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5Y32",
            "name":"Migration Application Data Service With Transformation",
            "displayName":"Application Data Service With Transformation",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5Y33",
            "name":"MigrationFilePrepareAndDeploy",
            "displayName":"File Prepare And Deploy",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5Y34",
            "name":"FINS BIB",
            "displayName":"FINS BIB",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         }
      ]
   }
]

Getting a Migration Plan by Name

You can get a migration plan by name for your migration by sending an HTTP GET request to the Siebel Migration Application.

The following details are for a request to update a connection for a migration:

URI: https://{hostname}:{port}/siebel/v1.0/migration/plan/{planName}
HTTP Method: GET
Content-Type: application/json
Authorization: Basic

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json

Response Body:

   {  
      "id":"88-1V5WMR",
      "name":"IRRMigration",
      "description":"IRRMigration",
      "source":"Dev",
      "target":"Prod",
      "resources":[  
         {  
            "id":"88-1V5WMS",
            "name":"Migration Schema Service",
            "displayName":"Schema Service",
            "isSelected":"true",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5WMT",
            "name":"Migration Design Repository Data Service",
            "displayName":"Design Repository Data Service",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5WMU",
            "name":"Migration Runtime Repository Data Service",
            "displayName":"Runtime Repository Data Service",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5WMV",
            "name":"Migration Application Workspace Data Service",
            "displayName":"Application Workspace Data Service",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5WMW",
            "name":"Migration Incremental Runtime Repository Data Service",
            "displayName":"Incremental Runtime Repository Data Service",
            "isSelected":"true",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5WMX",
            "name":"Migration Incremental Application Workspace Data Service",
            "displayName":"Incremental Application Workspace Data Service",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5WMY",
            "name":"Migration Application Data Service",
            "displayName":"Application Data Service",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5WMZ",
            "name":"Migration Application Data Service With Transformation",
            "displayName":"Application Data Service With Transformation",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5WN0",
            "name":"MigrationFilePrepareAndDeploy",
            "displayName":"File Prepare And Deploy",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         },
         {  
            "id":"88-1V5WN1",
            "name":"FINS BIB",
            "displayName":"FINS BIB",
            "isSelected":"false",
            "integrationBranchName":"",
            "versionNumber":"0",
            "language":"",
            "sequenceNumber":"0"
         }
      ]
   },

Creating a New Migration Plan

You can create a new migration plan for your migration by sending an HTTP POST request to the Siebel Migration Application.

The following details are for a request to create a new migration plan for a migration:

URI: https://{hostname}:{port}/siebel/v1.0/migration/plan
HTTP Method: POST
Content-Type: application/json
Authorization: Basic

Request Body:

{
   "name":"Demo Data Mig",
   "description":"Demo Data Migration",
   "source":"Dev",
   "target":"Prod",
   "resources":[
      {
         "id":"88-1V5WLP",
         "name":"Migration Schema Service",
         "displayName":"Schema Service",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {
         "id":"88-1V5WLQ",
         "name":"Migration Design Repository Data Service",
         "displayName":"Design Repository Data Service",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {
         "id":"88-1V5WLR",
         "name":"Migration Runtime Repository Data Service",
         "displayName":"Runtime Repository Data Service",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {
         "id":"88-1V5WLS",
         "name":"Migration Application Workspace Data Service",
         "displayName":"Application Workspace Data Service",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {
         "id":"88-1V5WLT",
         "name":"Migration Incremental Runtime Repository Data Service",
         "displayName":"Incremental Runtime Repository Data Service",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {
         "id":"88-1V5WLU",
         "name":"Migration Incremental Application Workspace Data Service",
         "displayName":"Incremental Application Workspace Data Service",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {
         "id":"88-1V5WLV",
         "name":"Migration Application Data Service",
         "displayName":"Application Data Service",
         "isSelected":"true",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {
         "id":"88-1V5WLW",
         "name":"Migration Application Data Service With Transformation",
         "displayName":"Application Data Service With Transformation",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {
         "id":"88-1V5WLX",
         "name":"MigrationFilePrepareAndDeploy",
         "displayName":"File Prepare And Deploy",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {
         "id":"88-1V5WLY",
         "name":"FINS BIB",
         "displayName":"FINS BIB",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      }
   ]
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json

Response Body:

{
   "name":"Demo Data Mig",
   "description":"Demo Data Migration",
   "source":"Dev",
   "target":"Prod",
   "resources":[
      {
         "id":"88-1V5WLP",
         "name":"Migration Schema Service",
         "displayName":"Schema Service",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {
         "id":"88-1V5WLQ",
         "name":"Migration Design Repository Data Service",
         "displayName":"Design Repository Data Service",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {
         "id":"88-1V5WLR",
         "name":"Migration Runtime Repository Data Service",
         "displayName":"Runtime Repository Data Service",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {
         "id":"88-1V5WLS",
         "name":"Migration Application Workspace Data Service",
         "displayName":"Application Workspace Data Service",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {  
         "id":"88-1V5WLT",
         "name":"Migration Incremental Runtime Repository Data Service",
         "displayName":"Incremental Runtime Repository Data Service",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {
         "id":"88-1V5WLU",
         "name":"Migration Incremental Application Workspace Data Service",
         "displayName":"Incremental Application Workspace Data Service",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {
         "id":"88-1V5WLV",
         "name":"Migration Application Data Service",
         "displayName":"Application Data Service",
         "isSelected":"true",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {
         "id":"88-1V5WLW",
         "name":"Migration Application Data Service With Transformation",
         "displayName":"Application Data Service With Transformation",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {
         "id":"88-1V5WLX",
         "name":"MigrationFilePrepareAndDeploy",
         "displayName":"File Prepare And Deploy",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {
         "id":"88-1V5WLY",
         "name":"FINS BIB",
         "displayName":"FINS BIB",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      }
   ]
}

Updating a Migration Plan

You can update a migration plan for your migration by sending an HTTP PUT request to the Siebel Migration Application.

The following details are for a request to update a migration plan for a migration:

URI: https://{hostname}:{port}/siebel/v1.0/migration/plan/{planName}
HTTP Method: PUT
Content-Type: application/json
Authorization: Basic

Request Body:

{  
   "name":"Demo Data Migration Plan",
   "description":"Demo Data Migration for Winter",
   "source":"Dev",
   "target":"Prod",
   "resources":[  
      {  
         "name":"Migration Schema Service",
         "displayName":"Schema Service",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {  
         "name":"Migration Design Repository Data Service",
         "displayName":"Design Repository Data Service",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {  
         "name":"Migration Runtime Repository Data Service",
         "displayName":"Runtime Repository Data Service",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {  
         "name":"Migration Application Workspace Data Service",
         "displayName":"Application Workspace Data Service",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {  
         "name":"Migration Incremental Runtime Repository Data Service",
         "displayName":"Incremental Runtime Repository Data Service",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {  
         "name":"Migration Incremental Application Workspace Data Service",
         "displayName":"Incremental Application Workspace Data Service",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {  
         "name":"Migration Application Data Service",
         "displayName":"Application Data Service",
         "isSelected":"true",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {  
         "name":"Migration Application Data Service With Transformation",
         "displayName":"Application Data Service With Transformation",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {  
         "name":"MigrationFilePrepareAndDeploy",
         "displayName":"File Prepare And Deploy",
         "isSelected":"true",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      },
      {  
         "name":"FINS BIB",
         "displayName":"FINS BIB",
         "isSelected":"false",
         "integrationBranchName":"",
         "versionNumber":"0",
         "language":"",
         "sequenceNumber":"0"
      }
   ]
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response Body: None

Deleting a Migration Plan

You can delete for your migration by sending an HTTP DELETE request to the Siebel Migration Application.

The following details are for a request to delete a migration plan for a migration:

URI: https://{hostname}:{port}/siebel/v1.0/migration/plan/{planName}
HTTP Method: DELETE
Content-Type: application/json
Authorization: Basic
Request Body:
None

The following are the details for the response to a successful request:

HTTP Code: 200
Response Body: None

Using REST API to Execute Siebel Migration Plans

You can use the Siebel Migration REST API to execute migration plans.

This topic includes the following topics:

Executing a Migration Plan

You can execute a migration plan for your migration by sending an HTTP POST request to the Siebel Migration Application.

Depending on the migration service that you selected in your migration plan, you must provide the following additional information in your REST API request:

If you selected a Schema Service with Export & Import or Import only for your migration plan, then you must provide the following parameters and values in your REST API request:
- schemaUser. The name of the schema user.
- schemaPassword. The password for the schema user. The schemaPassword must be encrypted by using base64 in the REST API request.
- isUnicodeDatabase. If you are using a NON-UNICODE Database, then you must select the NON-UNICODE Database option.
If you selected the Incremental Runtime Repository or the Incremental Application Workspace Data Service or the File Prepare and Deploy Service with Export only for your migration plan, then you must provide the watermarkFilename parameter and value in your REST API request.
If you want to only migrate a specific version when run the Incremental Runtime Repository (Export & Import or Export only) migration, then you must provide the irrEndVersion parameter and value in the REST API request. If you do not provide the irrEndVersion parameter and value, then, the migration migrates up to the latest version.
For all Export only or Import only migration plans, you must provide the packageFilename parameter and value in the REST API request.

The following details are for a request to update a connection for a migration:

URI: https://{hostname}:{port}/siebel/v1.0/migration/execution/{planName}
HTTP Method: POST
Content-Type: application/json
Authorization: Basic

Request Body:

{
   "schemaUser":"",
   "schemaPassword":"",
   "watermarkFilename":"",
   "irrEndVersion":"",
   "packageFilename":"",
   "isUnicodeDatabase":""
}

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json

Response Body:

{  
   "id":"88-1V5YFC",
   "planName":"Data Mig",
   "description":"Data Mig",
   "status":"Running",
   "startDate":"2018-07-24 09:50:20",
   "endDate":"",
   "source":"Dev",
   "target":"Prod",
   "packageName":"",
   "resources":[  
      {  
         "id":"88-1V5YFD",
         "name":"",
         "operation":"Export",
         "sequenceNumber":"1",
         "mode":"Asynchronous",
         "status":"Not Started",
         "startTime":"",
         "endTime":"",
         "resourceType":""
      },
      {  
         "id":"88-1V5YFE",
         "name":"",
         "operation":"Import",
         "sequenceNumber":"2",
         "mode":"Asynchronous",
         "status":"Not Started",
         "startTime":"",
         "endTime":"",
         "resourceType":""
      }
   ]
}

Getting Status for a Running Migration Plan by Name

You can get status for a running migration plan by name for your migration by sending an HTTP GET request to the Siebel Migration Application.

The following details are for a request to get status for a migration plan by name for a migration:

URI: https://{hostname}:{port}/siebel/v1.0/migration/execution/{planName}
HTTP Method: GET
Content-Type: application/json
Authorization: Basic
Request Body: None

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json

Response Body:

{  
   "id":"88-1V5WPF",
   "planName":"IRRMigration",
   "description":"IRR Migration",
   "status":"Running",
   "startDate":"2018-07-17 04:33:54",
   "endDate":"",
   "source":"Dev",
   "target":"Prod",
   "packageName":"",
   "resources":[  
      {  
         "id":"88-1V5WPG",
         "name":"",
         "operation":"Export",
         "sequenceNumber":"1",
         "mode":"Asynchronous",
         "status":"Not Applicable",
         "startTime":"",
         "endTime":"",
         "resourceType":""
      },
      {  
         "id":"88-1V5WPH",
         "name":"",
         "operation":"Import",
         "sequenceNumber":"2",
         "mode":"Asynchronous",
         "status":"Not Applicable",
         "startTime":"",
         "endTime":"",
         "resourceType":""
      },
      {  
         "id":"88-1V5WPI",
         "name":"",
         "operation":"Export",
         "sequenceNumber":"3",
         "mode":"Asynchronous",
         "status":"Running",
         "startTime":"2018-07-17 04:33:55",
         "endTime":"",
         "resourceType":""
      },
      {  
         "id":"88-1V5WPJ",
         "name":"",
         "operation":"Import",
         "sequenceNumber":"4",
         "mode":"Asynchronous",
         "status":"Not Started",
         "startTime":"",
         "endTime":"",
         "resourceType":""
      },
      {  
         "id":"88-1V5WPK",
         "name":"",
         "operation":"ActivateWorkflowsTasks",
         "sequenceNumber":"5",
         "mode":"Asynchronous",
         "status":"Not Started",
         "startTime":"",
         "endTime":"",
         "resourceType":""
      },
      {  
         "id":"88-1V5WPL",
         "name":"",
         "operation":"DBCheck",
         "sequenceNumber":"6",
         "mode":"Asynchronous",
         "status":"Not Started",
         "startTime":"",
         "endTime":"",
         "resourceType":""
      }
   ]
}

Getting Status for a Running Migration Plan by Plan Name and Resource Name

You can get status for a running migration plan by plan name and resource name for your migration by sending an HTTP GET request to the Siebel Migration Application.

The following details are for a request to get status for a running migration plan by plan name and resource name for a migration:

URI: https://{hostname}:{port}/siebel/v1.0/migration/execution/{planName}/{resourceName}
HTTP Method: GET
Content-Type: application/json
Authorization: Basic
Request Body: None

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json

Response Body:

{  
   "id":"88-1V60OJ",
   "planName":"Repo Export",
   "description":"Repo Export",
   "status":"Running",
   "startDate":"2018-08-17 06:02:39",
   "endDate":"",
   "source":"Dev",
   "target":"",
   "packageName":"irr_export.zip",
   "resources":[  
      {  
         "id":"88-1V60OK",
         "name":"Schema Service",
         "operation":"Export",
         "sequenceNumber":"1",
         "mode":"Asynchronous",
         "status":"Not Applicable",
         "startTime":"",
         "endTime":"",
         "resourceType":"DB Util"
      },
      {  
         "id":"88-1V61H2",
         "name":"Incremental Runtime Repository Data Service",
         "operation":"Export",
         "sequenceNumber":"2",
         "mode":"Asynchronous",
         "status":"Running",
         "startTime":"2018-08-17 06:02:39",
         "endTime":"",
         "resourceType":"DB Util"
      }
   ]
}

Getting Execution Status by Migration Plan Name, Resource Name, and Operation

You can get execution status by migration plan name, resource name, and operation for your migration by sending an HTTP GET request to the Siebel Migration Application.

The following details are for a request to get execution status by migration plan name, resource name, and operation for a migration:

URI: https://{hostname}:{port}/siebel/v1.0/migration/execution/{planName}/{resourceName}/{operation}
HTTP Method: GET
Content-Type: application/json
Authorization: Basic
Request Body: None

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json

Response Body:

{  
   "id":"88-1V5WPF",
   "planName":"Test REST Execution",
   "description":"Test REST Execution",
   "status":"Running",
   "startDate":"2018-07-17 04:33:54",
   "endDate":"",
   "source":"Dev",
   "target":"Prod",
   "packageName":"",
   "resources":[  
      {  
         "id":"88-1V5WPI",
         "name":"Incremental Runtime Repository Data Service",
         "operation":"Export",
         "sequenceNumber":"3",
         "mode":"Asynchronous",
         "status":"Running",
         "startTime":"2018-07-17 04:33:55",
         "endTime":"",
         "resourceType":""
      }
   ]
}

Getting the Migration Execution Operation Log

You can get the migration execution operation log for your migration by sending an HTTP GET request to the Siebel Migration Application.

The following details are for a request to get the migration execution operation log for a migration:

URI: https://{hostname}:{port}/siebel/v1.0/migration/execution/{planName}/{resourceName}/{operation}/log
HTTP Method: GET
Content-Type: application/json
Authorization: Basic
Request Body: None

The response returns the migration execution operation log for your migration. The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json
Response Body:

Using REST API to Get Siebel Migration Plan History

You can use the Siebel Migration REST API to get migration plan history.

This topic includes the following topics:

Getting All Migration History

You can get all the history for your migration by sending an HTTP GET request to the Siebel Migration Application.

The following details are for a request to get all the history for a migration:

URI: https://{hostname}:{port}/siebel/v1.0/migration/history
HTTP Method: GET
Content-Type: application/json
Authorization: Basic
Request Body: None

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json

Response Body:

[  
   {  
      "id":"88-1V5YFC",
      "planName":"Data Mig",
      "description":"Data Mig",
      "status":"Success",
      "startDate":"2018-07-24 09:50:20",
      "endDate":"2018-07-24 09:51:07",
      "source":"Dev",
      "target":"Prod",
      "packageName":"",
      "resources":[  
         {  
            "id":"88-1V5YFD",
            "name":"Application Data Service",
            "operation":"Export",
            "sequenceNumber":"1",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-24 09:50:20",
            "endTime":"2018-07-24 09:50:36",
            "resourceType":"DB Util"
         },
         {  
            "id":"88-1V5YFE",
            "name":"Application Data Service",
            "operation":"Import",
            "sequenceNumber":"2",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-24 09:50:52",
            "endTime":"2018-07-24 09:51:07",
            "resourceType":"DB Util"
         }
      ]
   },
   {  
      "id":"88-1V5Y4X",
      "planName":"Data Mig",
      "description":"Data Mig",
      "status":"Success",
      "startDate":"2018-07-23 02:47:14",
      "endDate":"2018-07-23 02:48:00",
      "source":"Dev",
      "target":"Prod",
      "packageName":"",
      "resources":[  
         {  
            "id":"88-1V5Y4Y",
            "name":"Application Data Service",
            "operation":"Export",
            "sequenceNumber":"1",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-23 02:47:14",
            "endTime":"2018-07-23 02:47:29",
            "resourceType":"DB Util"
         },
         {  
            "id":"88-1V5Y4Z",
            "name":"Application Data Service",
            "operation":"Import",
            "sequenceNumber":"2",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-23 02:47:44",
            "endTime":"2018-07-23 02:47:59",
            "resourceType":"DB Util"
         }
      ]
   },
   {  
      "id":"88-1V5WOX",
      "planName":"IRRMigration",
      "description":"IRRMigration",
      "status":"Error",
      "startDate":"2018-07-17 04:29:06",
      "endDate":"2018-07-17 04:29:22",
      "source":"Dev",
      "target":"Prod1",
      "packageName":"",
      "resources":[  
         {  
            "id":"88-1V5WOY",
            "name":"Schema Service",
            "operation":"Export",
            "sequenceNumber":"1",
            "mode":"Asynchronous",
            "status":"Not Applicable",
            "startTime":"",
            "endTime":"",
            "resourceType":"DB Util"
         },
         {  
            "id":"88-1V5WOZ",
            "name":"Schema Service",
            "operation":"Import",
            "sequenceNumber":"2",
            "mode":"Asynchronous",
            "status":"Not Applicable",
            "startTime":"",
            "endTime":"",
            "resourceType":"DB Util"
         },
         {  
            "id":"88-1V5WP0",
            "name":"Incremental Runtime Repository Data Service",
            "operation":"Export",
            "sequenceNumber":"3",
            "mode":"Asynchronous",
            "status":"Error",
            "startTime":"2018-07-17 04:29:07",
            "endTime":"2018-07-17 04:29:22",
            "resourceType":"DB Util"
         },
         {  
            "id":"88-1V5WP1",
            "name":"Incremental Runtime Repository Data Service",
            "operation":"Import",
            "sequenceNumber":"4",
            "mode":"Asynchronous",
            "status":"Not Started",
            "startTime":"",
            "endTime":"",
            "resourceType":"DB Util"
         },
         {  
            "id":"88-1V5WP2",
            "name":"Incremental Runtime Repository Data Service",
            "operation":"ActivateWorkflowsTasks",
            "sequenceNumber":"5",
            "mode":"Asynchronous",
            "status":"Not Started",
            "startTime":"",
            "endTime":"",
            "resourceType":"DB Util"
         },
         {  
            "id":"88-1V5WP3",
            "name":"Incremental Runtime Repository Data Service",
            "operation":"DBCheck",
            "sequenceNumber":"6",
            "mode":"Asynchronous",
            "status":"Not Started",
            "startTime":"",
            "endTime":"",
            "resourceType":"DB Util"
         }
      ]
   },
   {  
      "id":"88-1V5WOU",
      "planName":"Rest Testing",
      "description":"Rest Testing",
      "status":"Error",
      "startDate":"2018-07-17 04:28:35",
      "endDate":"2018-07-17 04:28:51",
      "source":"Dev",
      "target":"Prod1",
      "packageName":"",
      "resources":[  
         {  
            "id":"88-1V5WOV",
            "name":"Application Data Service",
            "operation":"Export",
            "sequenceNumber":"1",
            "mode":"Asynchronous",
            "status":"Error",
            "startTime":"2018-07-17 04:28:35",
            "endTime":"2018-07-17 04:28:51",
            "resourceType":"DB Util"
         },
         {  
            "id":"88-1V5WOW",
            "name":"Application Data Service",
            "operation":"Import",
            "sequenceNumber":"2",
            "mode":"Asynchronous",
            "status":"Not Started",
            "startTime":"",
            "endTime":"",
            "resourceType":"DB Util"
         }
      ]
   },
   {  
      "id":"88-1V5WON",
      "planName":"IRRMigration",
      "description":"IRRMigration",
      "status":"Error",
      "startDate":"2018-07-17 04:28:06",
      "endDate":"2018-07-17 04:28:22",
      "source":"Dev",
      "target":"Prod1",
      "packageName":"",
      "resources":[  
         {  
            "id":"88-1V5WOO",
            "name":"Schema Service",
            "operation":"Export",
            "sequenceNumber":"1",
            "mode":"Asynchronous",
            "status":"Not Applicable",
            "startTime":"",
            "endTime":"",
            "resourceType":"DB Util"
         },
         {  
            "id":"88-1V5WOP",
            "name":"Schema Service",
            "operation":"Import",
            "sequenceNumber":"2",
            "mode":"Asynchronous",
            "status":"Not Applicable",
            "startTime":"",
            "endTime":"",
            "resourceType":"DB Util"
         },
         {  
            "id":"88-1V5WOQ",
            "name":"Incremental Runtime Repository Data Service",
            "operation":"Export",
            "sequenceNumber":"3",
            "mode":"Asynchronous",
            "status":"Error",
            "startTime":"2018-07-17 04:28:07",
            "endTime":"2018-07-17 04:28:22",
            "resourceType":"DB Util"
         },
         {  
            "id":"88-1V5WOR",
            "name":"Incremental Runtime Repository Data Service",
            "operation":"Import",
            "sequenceNumber":"4",
            "mode":"Asynchronous",
            "status":"Not Started",
            "startTime":"",
            "endTime":"",
            "resourceType":"DB Util"
         },
         {  
            "id":"88-1V5WOS",
            "name":"Incremental Runtime Repository Data Service",
            "operation":"ActivateWorkflowsTasks",
            "sequenceNumber":"5",
            "mode":"Asynchronous",
            "status":"Not Started",
            "startTime":"",
            "endTime":"",
            "resourceType":"DB Util"
         },
         {  
            "id":"88-1V5WOT",
            "name":"Incremental Runtime Repository Data Service",
            "operation":"DBCheck",
            "sequenceNumber":"6",
            "mode":"Asynchronous",
            "status":"Not Started",
            "startTime":"",
            "endTime":"",
            "resourceType":"DB Util"
         }
      ]
   }
]

Getting Migration History by Migration Plan Name

You can get the migration history by migration plan name for your migration by sending an HTTP GET request to the Siebel Migration Application.

The following details are for a request to get the migration history by migration plan name for a migration:

URI: https://{hostname}:{port}/siebel/v1.0/migration/history?plan=<planName>
HTTP Method: GET
Content-Type: application/json
Authorization: Basic
Request Body: None

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json

Response Body:

[
   {
      "id":"88-1V5YFF",
      "planName":"Data Mig",
      "description":"Data Mig",
      "status":"Success",
      "startDate":"2018-07-24 08:44:42",
      "endDate":"2018-07-24 08:45:27",
      "source":"Dev",
      "target":"Prod",
      "packageName":"",
      "resources":[
         {
            "id":"88-1V5YFG",
            "name":"Application Data Service",
            "operation":"Export",
            "sequenceNumber":"1",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-24 08:44:42",
            "endTime":"2018-07-24 08:44:57",
            "resourceType":"DB Util"
         },
         {
            "id":"88-1V5YFH",
            "name":"Application Data Service",
            "operation":"Import",
            "sequenceNumber":"2",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-24 08:45:12",
            "endTime":"2018-07-24 08:45:27",
            "resourceType":"DB Util"
         }
      ]
   },
   {
      "id":"88-1V5YFC",
      "planName":"Data Mig",
      "description":"Data Mig",
      "status":"Success",
      "startDate":"2018-07-24 09:50:20",
      "endDate":"2018-07-24 09:51:07",
      "source":"Dev",
      "target":"Prod",
      "packageName":null,
      "resources":[
         {
            "id":"88-1V5YFD",
            "name":"Application Data Service",
            "operation":"Export",
            "sequenceNumber":"1",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-24 09:50:20",
            "endTime":"2018-07-24 09:50:36",
            "resourceType":"DB Util"
         },
         {
            "id":"88-1V5YFE",
            "name":"Application Data Service",
            "operation":"Import",
            "sequenceNumber":"2",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-24 09:50:52",
            "endTime":"2018-07-24 09:51:07",
            "resourceType":"DB Util"
         }
      ]
   },
   {
      "id":"88-1V5YB6",
      "planName":"Data Mig",
      "description":"Data Mig",
      "status":"Success",
      "startDate":"2018-07-23 09:37:39",
      "endDate":"2018-07-23 09:38:24",
      "source":"Dev",
      "target":"Prod",
      "packageName":null,
      "resources":[
         {
            "id":"88-1V5YB7",
            "name":"Application Data Service",
            "operation":"Export",
            "sequenceNumber":"1",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-23 09:37:39",
            "endTime":"2018-07-23 09:37:54",
            "resourceType":"DB Util"
         },
         {
            "id":"88-1V5YB8",
            "name":"Application Data Service",
            "operation":"Import",
            "sequenceNumber":"2",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-23 09:38:09",
            "endTime":"2018-07-23 09:38:24",
            "resourceType":"DB Util"
         }
      ]
   },
   {
      "id":"88-1V5YAK",
      "planName":"Data Mig",
      "description":"Data Mig",
      "status":"Success",
      "startDate":"2018-07-23 09:09:48",
      "endDate":"2018-07-23 09:10:34",
      "source":"Dev",
      "target":"Prod",
      "packageName":"",
      "resources":[
         {
            "id":"88-1V5YAL",
            "name":"Application Data Service",
            "operation":"Export",
            "sequenceNumber":"1",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-23 09:09:48",
            "endTime":"2018-07-23 09:10:03",
            "resourceType":"DB Util"
         },
         {
            "id":"88-1V5YAM",
            "name":"Application Data Service",
            "operation":"Import",
            "sequenceNumber":"2",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-23 09:10:19",
            "endTime":"2018-07-23 09:10:34",
            "resourceType":"DB Util"
         }
      ]
   },
   {
      "id":"88-1V5YAH",
      "planName":"Data Mig",
      "description":"Data Mig",
      "status":"Success",
      "startDate":"2018-07-23 07:19:46",
      "endDate":"2018-07-23 07:20:32",
      "source":"Dev",
      "target":"Prod",
      "packageName":null,
      "resources":[
         {
            "id":"88-1V5YAI",
            "name":"Application Data Service",
            "operation":"Export",
            "sequenceNumber":"1",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-23 07:19:46",
            "endTime":"2018-07-23 07:20:01",
            "resourceType":"DB Util"
         },
         {
            "id":"88-1V5YAJ",
            "name":"Application Data Service",
            "operation":"Import",
            "sequenceNumber":"2",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-23 07:20:16",
            "endTime":"2018-07-23 07:20:32",
            "resourceType":"DB Util"
         }
      ]
   },
   {
      "id":"88-1V5Y6J",
      "planName":"Data Mig",
      "description":"Data Mig",
      "status":"Success",
      "startDate":"2018-07-23 06:20:12",
      "endDate":"2018-07-23 06:20:58",
      "source":"Dev",
      "target":"Prod",
      "packageName":null,
      "resources":[
         {
            "id":"88-1V5Y6K",
            "name":"Application Data Service",
            "operation":"Export",
            "sequenceNumber":"1",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-23 06:20:12",
            "endTime":"2018-07-23 06:20:27",
            "resourceType":"DB Util"
         },
         {
            "id":"88-1V5Y6L",
            "name":"Application Data Service",
            "operation":"Import",
            "sequenceNumber":"2",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-23 06:20:43",
            "endTime":"2018-07-23 06:20:58",
            "resourceType":"DB Util"
         }
      ]
   },
   {
      "id":"88-1V5Y5Y",
      "planName":"Data Mig",
      "description":"Data Mig",
      "status":"Success",
      "startDate":"2018-07-23 06:11:24",
      "endDate":"2018-07-23 06:12:37",
      "source":"Dev",
      "target":"Prod",
      "packageName":null,
      "resources":[
         {
            "id":"88-1V5Y5Z",
            "name":"Application Data Service",
            "operation":"Export",
            "sequenceNumber":"1",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-23 06:11:24",
            "endTime":"2018-07-23 06:11:39",
            "resourceType":"DB Util"
         },
         {
            "id":"88-1V5Y60",
            "name":"Application Data Service",
            "operation":"Import",
            "sequenceNumber":"2",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-23 06:11:54",
            "endTime":"2018-07-23 06:12:37",
            "resourceType":"DB Util"
         }
      ]
   },
   {
      "id":"88-1V5Y5S",
      "planName":"Data Mig",
      "description":"Data Mig",
      "status":"Success",
      "startDate":"2018-07-23 06:11:13",
      "endDate":"2018-07-23 06:12:17",
      "source":"Dev",
      "target":"Prod",
      "packageName":null,
      "resources":[
         {
            "id":"88-1V5Y5T",
            "name":"Application Data Service",
            "operation":"Export",
            "sequenceNumber":"1",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-23 06:11:13",
            "endTime":"2018-07-23 06:11:28",
            "resourceType":"DB Util"
         },
         {
            "id":"88-1V5Y5U",
            "name":"Application Data Service",
            "operation":"Import",
            "sequenceNumber":"2",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-23 06:11:43",
            "endTime":"2018-07-23 06:12:17",
            "resourceType":"DB Util"
         }
      ]
   },
   {  
      "id":"88-1V5Y5M",
      "planName":"Data Mig",
      "description":"Data Mig",
      "status":"Success",
      "startDate":"2018-07-23 06:11:07",
      "endDate":"2018-07-23 06:11:53",
      "source":"Dev",
      "target":"Prod",
      "packageName":null,
      "resources":[  
         {  
            "id":"88-1V5Y5N",
            "name":"Application Data Service",
            "operation":"Export",
            "sequenceNumber":"1",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-23 06:11:07",
            "endTime":"2018-07-23 06:11:22",
            "resourceType":"DB Util"
         },
         {  
            "id":"88-1V5Y5O",
            "name":"Application Data Service",
            "operation":"Import",
            "sequenceNumber":"2",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-23 06:11:38",
            "endTime":"2018-07-23 06:11:53",
            "resourceType":"DB Util"
         }
      ]
   },
   {
      "id":"88-1V5Y5P",
      "planName":"Data Mig",
      "description":"Data Mig",
      "status":"Error",
      "startDate":"2018-07-23 06:11:09",
      "endDate":"2018-07-23 06:11:39",
      "source":"Dev",
      "target":"Prod",
      "packageName":null,
      "resources":[
         {
            "id":"88-1V5Y5Q",
            "name":"Application Data Service",
            "operation":"Export",
            "sequenceNumber":"1",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-23 06:11:09",
            "endTime":"2018-07-23 06:11:24",
            "resourceType":"DB Util"
         },
         {
            "id":"88-1V5Y5R",
            "name":"Application Data Service",
            "operation":"Import",
            "sequenceNumber":"2",
            "mode":"Asynchronous",
            "status":"Not Started",
            "startTime":"",
            "endTime":"",
            "resourceType":"DB Util"
         }
      ]
   },
   {
      "id":"88-1V5Y4X",
      "planName":"Data Mig",
      "description":"Data Mig",
      "status":"Success",
      "startDate":"2018-07-23 02:47:14",
      "endDate":"2018-07-23 02:48:00",
      "source":"Dev",
      "target":"Prod",
      "packageName":null,
      "resources":[  
         {
            "id":"88-1V5Y4Y",
            "name":"Application Data Service",
            "operation":"Export",
            "sequenceNumber":"1",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-23 02:47:14",
            "endTime":"2018-07-23 02:47:29",
            "resourceType":"DB Util"
         },
         {
            "id":"88-1V5Y4Z",
            "name":"Application Data Service",
            "operation":"Import",
            "sequenceNumber":"2",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-23 02:47:44",
            "endTime":"2018-07-23 02:47:59",
            "resourceType":"DB Util"
         }
      ]
   },
   {
      "id":"88-1V5Y4B",
      "planName":"Data Mig",
      "description":"Data Mig",
      "status":"Success",
      "startDate":"2018-07-23 02:36:26",
      "endDate":"2018-07-23 02:38:36",
      "source":"Dev",
      "target":"Prod",
      "packageName":null,
      "resources":[
         {
            "id":"88-1V5Y4C",
            "name":"Application Data Service",
            "operation":"Export",
            "sequenceNumber":"1",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-23 02:37:50",
            "endTime":"2018-07-23 02:38:06",
            "resourceType":"DB Util"
         },
         {
            "id":"88-1V5Y4D",
            "name":"Application Data Service",
            "operation":"Import",
            "sequenceNumber":"2",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-23 02:38:21",
            "endTime":"2018-07-23 02:38:36",
            "resourceType":"DB Util"
         }
      ]
   },
   {
      "id":"88-1V5Y48",
      "planName":"Data Mig",
      "description":"Data Mig",
      "status":"Success",
      "startDate":"2018-07-23 02:30:33",
      "endDate":"2018-07-23 02:31:19",
      "source":"Dev",
      "target":"Prod",
      "packageName":null,
      "resources":[
         {
            "id":"88-1V5Y49",
            "name":"Application Data Service",
            "operation":"Export",
            "sequenceNumber":"1",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-23 02:30:33",
            "endTime":"2018-07-23 02:30:48",
            "resourceType":"DB Util"
         },
         {
            "id":"88-1V5Y4A",
            "name":"Application Data Service",
            "operation":"Import",
            "sequenceNumber":"2",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-23 02:31:03",
            "endTime":"2018-07-23 02:31:18",
            "resourceType":"DB Util"
         }
      ]
   },
   {
      "id":"88-1V5Y3J",
      "planName":"Data Mig",
      "description":"Data Mig",
      "status":"Success",
      "startDate":"2018-07-22 11:26:29",
      "endDate":"2018-07-22 11:27:15",
      "source":"Dev",
      "target":"Prod",
      "packageName":"",
      "resources":[
         {
            "id":"88-1V5Y3K",
            "name":"Application Data Service",
            "operation":"Export",
            "sequenceNumber":"1",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-22 11:26:29",
            "endTime":"2018-07-22 11:26:44",
            "resourceType":"DB Util"
         },
         {
            "id":"88-1V5Y3L",
            "name":"Application Data Service",
            "operation":"Import",
            "sequenceNumber":"2",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-22 11:27:00",
            "endTime":"2018-07-22 11:27:15",
            "resourceType":"DB Util"
         }
      ]
   },
   {
      "id":"88-1V5Y35",
      "planName":"Data Mig",
      "description":"Data Mig",
      "status":"Success",
      "startDate":"2018-07-22 11:17:16",
      "endDate":"2018-07-22 11:18:03",
      "source":"Dev",
      "target":"Prod",
      "packageName":"",
      "resources":[
         {
            "id":"88-1V5Y36",
            "name":"Application Data Service",
            "operation":"Export",
            "sequenceNumber":"1",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-22 11:17:16",
            "endTime":"2018-07-22 11:17:31",
            "resourceType":"DB Util"
         },
         {
            "id":"88-1V5Y37",
            "name":"Application Data Service",
            "operation":"Import",
            "sequenceNumber":"2",
            "mode":"Asynchronous",
            "status":"Success",
            "startTime":"2018-07-22 11:17:48",
            "endTime":"2018-07-22 11:18:03",
            "resourceType":"DB Util"
         }
      ]
   }
]

Getting Migration History by ID Number

You can get a migration history by ID number for your migration by sending an HTTP GET request to the Siebel Migration Application.

The following details are for a request to get a migration history by ID number for a migration:

URI: https://{hostname}:{port}/siebel/v1.0/migration/history/{id}
HTTP Method: GET
Content-Type: application/json
Authorization: Basic
Request Body: None

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json

Response Body:

{  
   "id":"88-1V5WON",
   "planName":"IRRMigration",
   "description":"IRRMigration",
   "status":"Error",
   "startDate":"2018-07-17 04:28:06",
   "endDate":"2018-07-17 04:28:22",
   "source":"Dev",
   "target":"Prod1",
   "packageName":"",
   "resources":[  
      {  
         "id":"88-1V5WOO",
         "name":"Schema Service",
         "operation":"Export",
         "sequenceNumber":"1",
         "mode":"Asynchronous",
         "status":"Not Applicable",
         "startTime":"",
         "endTime":"",
         "resourceType":"DB Util"
      },
      {  
         "id":"88-1V5WOP",
         "name":"Schema Service",
         "operation":"Import",
         "sequenceNumber":"2",
         "mode":"Asynchronous",
         "status":"Not Applicable",
         "startTime":"",
         "endTime":"",
         "resourceType":"DB Util"
      },
      {  
         "id":"88-1V5WOQ",
         "name":"Incremental Runtime Repository Data Service",
         "operation":"Export",
         "sequenceNumber":"3",
         "mode":"Asynchronous",
         "status":"Error",
         "startTime":"2018-07-17 04:28:07",
         "endTime":"2018-07-17 04:28:22",
         "resourceType":"DB Util"
      },
      {  
         "id":"88-1V5WOR",
         "name":"Incremental Runtime Repository Data Service",
         "operation":"Import",
         "sequenceNumber":"4",
         "mode":"Asynchronous",
         "status":"Not Started",
         "startTime":"",
         "endTime":"",
         "resourceType":"DB Util"
      },
      {  
         "id":"88-1V5WOS",
         "name":"Incremental Runtime Repository Data Service",
         "operation":"ActivateWorkflowsTasks",
         "sequenceNumber":"5",
         "mode":"Asynchronous",
         "status":"Not Started",
         "startTime":"",
         "endTime":"",
         "resourceType":"DB Util"
      },
      {  
         "id":"88-1V5WOT",
         "name":"Incremental Runtime Repository Data Service",
         "operation":"DBCheck",
         "sequenceNumber":"6",
         "mode":"Asynchronous",
         "status":"Not Started",
         "startTime":"",
         "endTime":"",
         "resourceType":"DB Util"
      }
   ]
}

Getting Migration History by ID and Resource Name

You can get the migration history by ID and resource name for your migration by sending an HTTP Get request to the Siebel Migration Application.

The following details are for a request to get the migration history by ID and resource name for a migration:

URI: https://{hostname}:{port}/siebel/v1.0/migration/history/{id}/{resourceName}
HTTP Method: GET
Content-Type: application/json
Authorization: Basic
Request Body: None

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json

Response Body:

{  
   "id":"88-1V5WON",
   "planName":"IRRMigration",
   "description":"IRRMigration",
   "status":"Error",
   "startDate":"2018-07-17 04:28:06",
   "endDate":"2018-07-17 04:28:22",
   "source":"Dev",
   "target":"Prod1",
   "packageName":"",
   "resources":[  
      {  
         "id":"88-1V5WOQ",
         "name":"Incremental Runtime Repository Data Service",
         "operation":"Export",
         "sequenceNumber":"3",
         "mode":"Asynchronous",
         "status":"Error",
         "startTime":"2018-07-17 04:28:07",
         "endTime":"2018-07-17 04:28:22",
         "resourceType":"DB Util"
      },
      {  
         "id":"88-1V5WOR",
         "name":"Incremental Runtime Repository Data Service",
         "operation":"Import",
         "sequenceNumber":"4",
         "mode":"Asynchronous",
         "status":"Not Started",
         "startTime":"",
         "endTime":"",
         "resourceType":"DB Util"
      },
      {  
         "id":"88-1V5WOS",
         "name":"Incremental Runtime Repository Data Service",
         "operation":"ActivateWorkflowsTasks",
         "sequenceNumber":"5",
         "mode":"Asynchronous",
         "status":"Not Started",
         "startTime":"",
         "endTime":"",
         "resourceType":"DB Util"
      },
      {  
         "id":"88-1V5WOT",
         "name":"Incremental Runtime Repository Data Service",
         "operation":"DBCheck",
         "sequenceNumber":"6",
         "mode":"Asynchronous",
         "status":"Not Started",
         "startTime":"",
         "endTime":"",
         "resourceType":"DB Util"
      }
   ]
}

Getting Migration History by ID, Resource Name, and Operation

You can get migration history by ID, resource name, and operation for your migration by sending an HTTP GET request to the Siebel Migration Application.

The following details are for a request to get migration history by ID, resource name, and operation for a migration:

URI: https://{hostname}:{port}/siebel/v1.0/migration/history/{id}/{resourceName}/{operation}
HTTP Method: GET
Content-Type: application/json
Authorization: Basic
Request Body: None

The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json

Response Body:

{  
   "id":"88-1V5WON",
   "planName":"IRRMigration",
   "description":"IRRMigration",
   "status":"Error",
   "startDate":"2018-07-17 04:28:06",
   "endDate":"2018-07-17 04:28:22",
   "source":"Dev",
   "target":"Prod1",
   "packageName":"",
   "resources":[  
      {  
         "id":"88-1V5WOQ",
         "name":"Incremental Runtime Repository Data Service",
         "operation":"Export",
         "sequenceNumber":"3",
         "mode":"Asynchronous",
         "status":"Error",
         "startTime":"2018-07-17 04:28:07",
         "endTime":"2018-07-17 04:28:22",
         "resourceType":"DB Util"
      }
   ]
}

Getting the Migration History Operation Log

You can get the migration history operation log for your migration by sending an HTTP GET request to the Siebel Migration Application.

The following details are for a request to get the migration history operation log for a migration:

URI: https://{hostname}:{port}/siebel/v1.0/migration/history/{id}/{resourceName}/{operation}/log
HTTP Method: GET
Content-Type: application/json
Authorization: Basic
Request Body: None

The response returns the migration history operation log for your migration. The following are the details for the response to a successful request:

HTTP Code: 200
Content-Type: application/json