Web Service: ConfigurationService
Port ConfigurationService
Port type IConfigurationService
1. GetFieldDtosByTableCatalogId
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConfigurationService_GetFieldDtosByTableCatalogId_InputMessage (soap:body, use = literal)
parameters type GetFieldDtosByTableCatalogId
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| id | Optional | long | id parameter |
Output: IConfigurationService_GetFieldDtosByTableCatalogId_OutputMessage (soap:body, use = literal)
parameters type GetFieldDtosByTableCatalogIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetFieldDtosByTableCatalogIdResult | Optional | ArrayOfFieldDto | GetFieldDtosByTableCatalogIdResult parameter (nillable) |
| FieldDto | Optional | FieldDto | FieldDto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| ColumnOrder | Optional | int | ColumnOrder parameter |
| Description | Optional | string | Description parameter (nillable) |
| DisplayType | Optional | int | DisplayType parameter (nillable) |
| FieldCatalogId | Optional | long | FieldCatalogId parameter (nillable) |
| FieldCatalogName | Optional | string | FieldCatalogName parameter (nillable) |
| IsAuditable | Optional | boolean | IsAuditable parameter |
| IsKey | Optional | boolean | IsKey parameter |
| IsSearchable | Optional | boolean | IsSearchable parameter |
| IsUnique | Optional | boolean | IsUnique parameter |
| Name | Optional | string | Name parameter (nillable) |
| ReadOnly | Optional | boolean | ReadOnly parameter |
| Required | Optional | boolean | Required parameter |
| RequiredLinkedFields | Optional | ArrayOflong | RequiredLinkedFields parameter (nillable) |
| long | Optional | long | long parameter |
| Size | Optional | long | Size parameter |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| Type | Optional | string | Type parameter (nillable) |
| WrapText | Optional | boolean | WrapText parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ConfigurationServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long id = 123;
// Call the service method
var response = client.GetFieldDtosByTableCatalogId(sessionId, impersonateAccountId, id);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:GetFieldDtosByTableCatalogId>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:id>123</bas:id>
</bas:GetFieldDtosByTableCatalogId>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConfigurationService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$id = 123
# Call the service method
$result = $proxy.GetFieldDtosByTableCatalogId($sessionId, $impersonateAccountId, $id)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
2. GetQueriesByDTO
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConfigurationService_GetQueriesByDTO_InputMessage (soap:body, use = literal)
parameters type GetQueriesByDTO
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | QueryDto | dto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| ShortName | Optional | string | ShortName parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| Type | Optional | QueryType | System, User, ISM, PMSTask |
| page | Optional | long | page parameter (nillable) |
Output: IConfigurationService_GetQueriesByDTO_OutputMessage (soap:body, use = literal)
parameters type GetQueriesByDTOResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetQueriesByDTOResult | Optional | ArrayOfQueryDto | GetQueriesByDTOResult parameter (nillable) |
| QueryDto | Optional | QueryDto | QueryDto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| ShortName | Optional | string | ShortName parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| Type | Optional | QueryType | System, User, ISM, PMSTask |
Code Examples
C# Example
// Create the service client
using (var client = new ConfigurationServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new QueryDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetQueriesByDTO(sessionId, impersonateAccountId, dto);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:GetQueriesByDTO>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- QueryDto properties here -->
</bas:dto>
</bas:GetQueriesByDTO>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConfigurationService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object QueryDto
# Call the service method
$result = $proxy.GetQueriesByDTO($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
3. GetQueryById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConfigurationService_GetQueryById_InputMessage (soap:body, use = literal)
parameters type GetQueryById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Output: IConfigurationService_GetQueryById_OutputMessage (soap:body, use = literal)
parameters type GetQueryByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetQueryByIdResult | Optional | QueryDto | GetQueryByIdResult parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| ShortName | Optional | string | ShortName parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| Type | Optional | QueryType | System, User, ISM, PMSTask |
Code Examples
C# Example
// Create the service client
using (var client = new ConfigurationServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.GetQueryById(sessionId, impersonateAccountId, entityId);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:GetQueryById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:GetQueryById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConfigurationService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.GetQueryById($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
4. GetStatesByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConfigurationService_GetStatesByDto_InputMessage (soap:body, use = literal)
parameters type GetStatesByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | StateDto | dto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| Description | Optional | string | Description parameter (nillable) |
| DisplayName | Optional | string | DisplayName parameter (nillable) |
| IgnoreTransitions | Optional | boolean | IgnoreTransitions parameter (nillable) |
| ImageKey | Optional | string | ImageKey parameter (nillable) |
| IsDefault | Optional | boolean | IsDefault parameter (nillable) |
| IsDeletedState | Optional | boolean | IsDeletedState parameter (nillable) |
| IsReadOnlyState | Optional | boolean | IsReadOnlyState parameter (nillable) |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| IsSystemOnlyState | Optional | boolean | IsSystemOnlyState parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| Ordinal | Optional | int | Ordinal parameter (nillable) |
| ReadOnly | Optional | boolean | ReadOnly parameter (nillable) |
| StateGroup | Optional | string | StateGroup parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| StateType | Optional | StateTypes | Active, Suspended, History |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| page | Optional | long | page parameter (nillable) |
Output: IConfigurationService_GetStatesByDto_OutputMessage (soap:body, use = literal)
parameters type GetStatesByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetStatesByDtoResult | Optional | ArrayOfStateDto | GetStatesByDtoResult parameter (nillable) |
| StateDto | Optional | StateDto | StateDto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| Description | Optional | string | Description parameter (nillable) |
| DisplayName | Optional | string | DisplayName parameter (nillable) |
| IgnoreTransitions | Optional | boolean | IgnoreTransitions parameter (nillable) |
| ImageKey | Optional | string | ImageKey parameter (nillable) |
| IsDefault | Optional | boolean | IsDefault parameter (nillable) |
| IsDeletedState | Optional | boolean | IsDeletedState parameter (nillable) |
| IsReadOnlyState | Optional | boolean | IsReadOnlyState parameter (nillable) |
| IsSystem | Optional | boolean | IsSystem parameter (nillable) |
| IsSystemOnlyState | Optional | boolean | IsSystemOnlyState parameter (nillable) |
| Name | Optional | string | Name parameter (nillable) |
| Ordinal | Optional | int | Ordinal parameter (nillable) |
| ReadOnly | Optional | boolean | ReadOnly parameter (nillable) |
| StateGroup | Optional | string | StateGroup parameter (nillable) |
| StateId | Optional | long | StateId parameter (nillable) |
| StateType | Optional | StateTypes | Active, Suspended, History |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ConfigurationServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new StateDto
{
// Set DTO properties here
};
// Call the service method
var response = client.GetStatesByDto(sessionId, impersonateAccountId, dto);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:GetStatesByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- StateDto properties here -->
</bas:dto>
</bas:GetStatesByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConfigurationService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object StateDto
# Call the service method
$result = $proxy.GetStatesByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
5. GetTableCatalogById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConfigurationService_GetTableCatalogById_InputMessage (soap:body, use = literal)
parameters type GetTableCatalogById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Output: IConfigurationService_GetTableCatalogById_OutputMessage (soap:body, use = literal)
parameters type GetTableCatalogByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetTableCatalogByIdResult | Optional | TableDto | GetTableCatalogByIdResult parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AllowHazards | Optional | boolean | AllowHazards parameter |
| AutoCompleteType | Optional | long | AutoCompleteType parameter (nillable) |
| CreateWebMethodName | Optional | string | CreateWebMethodName parameter (nillable) |
| CreatedBy | Optional | long | CreatedBy parameter (nillable) |
| CreatedDate | Optional | dateTime | CreatedDate parameter |
| DefaultPageSize | Optional | int | DefaultPageSize parameter (nillable) |
| Deleted | Optional | boolean | Deleted parameter |
| Description | Optional | string | Description parameter (nillable) |
| DisplayEvents | Optional | boolean | DisplayEvents parameter |
| DisplayFormat | Optional | string | DisplayFormat parameter (nillable) |
| EntityTypeName | Optional | string | EntityTypeName parameter (nillable) |
| FriendlyName | Optional | string | FriendlyName parameter (nillable) |
| Hash | Optional | string | Hash parameter (nillable) |
| InterfaceTypeName | Optional | string | InterfaceTypeName parameter (nillable) |
| IsMobileAudited | Optional | boolean | IsMobileAudited parameter |
| MaxPageSize | Optional | int | MaxPageSize parameter (nillable) |
| MobileSystemAuditable | Optional | boolean | MobileSystemAuditable parameter |
| ModifiedBy | Optional | long | ModifiedBy parameter (nillable) |
| ModifiedDate | Optional | dateTime | ModifiedDate parameter |
| Name | Optional | string | Name parameter (nillable) |
| OffloadLongRunningTasks | Optional | boolean | OffloadLongRunningTasks parameter |
| OffloadThreshold | Optional | int | OffloadThreshold parameter (nillable) |
| PmsCoreValue | Optional | boolean | PmsCoreValue parameter |
| PublishDreamscapeData | Optional | boolean | PublishDreamscapeData parameter (nillable) |
| PublishMobileData | Optional | boolean | PublishMobileData parameter |
| ReadOnly | Optional | boolean | ReadOnly parameter |
| StoreAttributesAndProperties | Optional | boolean | StoreAttributesAndProperties parameter |
| StoreBimDocuments | Optional | boolean | StoreBimDocuments parameter |
| StoreDocuments | Optional | boolean | StoreDocuments parameter |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| Type | Optional | long | Type parameter (nillable) |
| UpdateWebMethodName | Optional | string | UpdateWebMethodName parameter (nillable) |
| Version | Optional | long | Version parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ConfigurationServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.GetTableCatalogById(sessionId, impersonateAccountId, entityId);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:GetTableCatalogById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:GetTableCatalogById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConfigurationService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.GetTableCatalogById($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
6. GetTableCatalogByName
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConfigurationService_GetTableCatalogByName_InputMessage (soap:body, use = literal)
parameters type GetTableCatalogByName
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| name | Optional | string | name parameter (nillable) |
Output: IConfigurationService_GetTableCatalogByName_OutputMessage (soap:body, use = literal)
parameters type GetTableCatalogByNameResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetTableCatalogByNameResult | Optional | TableDto | GetTableCatalogByNameResult parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AllowHazards | Optional | boolean | AllowHazards parameter |
| AutoCompleteType | Optional | long | AutoCompleteType parameter (nillable) |
| CreateWebMethodName | Optional | string | CreateWebMethodName parameter (nillable) |
| CreatedBy | Optional | long | CreatedBy parameter (nillable) |
| CreatedDate | Optional | dateTime | CreatedDate parameter |
| DefaultPageSize | Optional | int | DefaultPageSize parameter (nillable) |
| Deleted | Optional | boolean | Deleted parameter |
| Description | Optional | string | Description parameter (nillable) |
| DisplayEvents | Optional | boolean | DisplayEvents parameter |
| DisplayFormat | Optional | string | DisplayFormat parameter (nillable) |
| EntityTypeName | Optional | string | EntityTypeName parameter (nillable) |
| FriendlyName | Optional | string | FriendlyName parameter (nillable) |
| Hash | Optional | string | Hash parameter (nillable) |
| InterfaceTypeName | Optional | string | InterfaceTypeName parameter (nillable) |
| IsMobileAudited | Optional | boolean | IsMobileAudited parameter |
| MaxPageSize | Optional | int | MaxPageSize parameter (nillable) |
| MobileSystemAuditable | Optional | boolean | MobileSystemAuditable parameter |
| ModifiedBy | Optional | long | ModifiedBy parameter (nillable) |
| ModifiedDate | Optional | dateTime | ModifiedDate parameter |
| Name | Optional | string | Name parameter (nillable) |
| OffloadLongRunningTasks | Optional | boolean | OffloadLongRunningTasks parameter |
| OffloadThreshold | Optional | int | OffloadThreshold parameter (nillable) |
| PmsCoreValue | Optional | boolean | PmsCoreValue parameter |
| PublishDreamscapeData | Optional | boolean | PublishDreamscapeData parameter (nillable) |
| PublishMobileData | Optional | boolean | PublishMobileData parameter |
| ReadOnly | Optional | boolean | ReadOnly parameter |
| StoreAttributesAndProperties | Optional | boolean | StoreAttributesAndProperties parameter |
| StoreBimDocuments | Optional | boolean | StoreBimDocuments parameter |
| StoreDocuments | Optional | boolean | StoreDocuments parameter |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| Type | Optional | long | Type parameter (nillable) |
| UpdateWebMethodName | Optional | string | UpdateWebMethodName parameter (nillable) |
| Version | Optional | long | Version parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ConfigurationServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
string name = "your_value_here";
// Call the service method
var response = client.GetTableCatalogByName(sessionId, impersonateAccountId, name);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:GetTableCatalogByName>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:name>sample_value</bas:name>
</bas:GetTableCatalogByName>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConfigurationService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$name = "your_value_here"
# Call the service method
$result = $proxy.GetTableCatalogByName($sessionId, $impersonateAccountId, $name)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
7. GetTableDtosForImport
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConfigurationService_GetTableDtosForImport_InputMessage (soap:body, use = literal)
parameters type GetTableDtosForImport
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
Output: IConfigurationService_GetTableDtosForImport_OutputMessage (soap:body, use = literal)
parameters type GetTableDtosForImportResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetTableDtosForImportResult | Optional | ArrayOfTableDto | GetTableDtosForImportResult parameter (nillable) |
| TableDto | Optional | TableDto | TableDto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AllowHazards | Optional | boolean | AllowHazards parameter |
| AutoCompleteType | Optional | long | AutoCompleteType parameter (nillable) |
| CreateWebMethodName | Optional | string | CreateWebMethodName parameter (nillable) |
| CreatedBy | Optional | long | CreatedBy parameter (nillable) |
| CreatedDate | Optional | dateTime | CreatedDate parameter |
| DefaultPageSize | Optional | int | DefaultPageSize parameter (nillable) |
| Deleted | Optional | boolean | Deleted parameter |
| Description | Optional | string | Description parameter (nillable) |
| DisplayEvents | Optional | boolean | DisplayEvents parameter |
| DisplayFormat | Optional | string | DisplayFormat parameter (nillable) |
| EntityTypeName | Optional | string | EntityTypeName parameter (nillable) |
| FriendlyName | Optional | string | FriendlyName parameter (nillable) |
| Hash | Optional | string | Hash parameter (nillable) |
| InterfaceTypeName | Optional | string | InterfaceTypeName parameter (nillable) |
| IsMobileAudited | Optional | boolean | IsMobileAudited parameter |
| MaxPageSize | Optional | int | MaxPageSize parameter (nillable) |
| MobileSystemAuditable | Optional | boolean | MobileSystemAuditable parameter |
| ModifiedBy | Optional | long | ModifiedBy parameter (nillable) |
| ModifiedDate | Optional | dateTime | ModifiedDate parameter |
| Name | Optional | string | Name parameter (nillable) |
| OffloadLongRunningTasks | Optional | boolean | OffloadLongRunningTasks parameter |
| OffloadThreshold | Optional | int | OffloadThreshold parameter (nillable) |
| PmsCoreValue | Optional | boolean | PmsCoreValue parameter |
| PublishDreamscapeData | Optional | boolean | PublishDreamscapeData parameter (nillable) |
| PublishMobileData | Optional | boolean | PublishMobileData parameter |
| ReadOnly | Optional | boolean | ReadOnly parameter |
| StoreAttributesAndProperties | Optional | boolean | StoreAttributesAndProperties parameter |
| StoreBimDocuments | Optional | boolean | StoreBimDocuments parameter |
| StoreDocuments | Optional | boolean | StoreDocuments parameter |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| Type | Optional | long | Type parameter (nillable) |
| UpdateWebMethodName | Optional | string | UpdateWebMethodName parameter (nillable) |
| Version | Optional | long | Version parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ConfigurationServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
// Call the service method
var response = client.GetTableDtosForImport(sessionId, impersonateAccountId);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:GetTableDtosForImport>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
</bas:GetTableDtosForImport>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConfigurationService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
# Call the service method
$result = $proxy.GetTableDtosForImport($sessionId, $impersonateAccountId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
8. UpdateTableCatalog
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConfigurationService_UpdateTableCatalog_InputMessage (soap:body, use = literal)
parameters type UpdateTableCatalog
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | TableDto | dto parameter (nillable) |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| FilterQueryId | Optional | long | FilterQueryId parameter |
| PrimaryKeyId | Optional | long | PrimaryKeyId parameter |
| PrimaryTableCatalogId | Optional | long | PrimaryTableCatalogId parameter |
| ValidateOnly | Optional | boolean | ValidateOnly parameter |
| AllowHazards | Optional | boolean | AllowHazards parameter |
| AutoCompleteType | Optional | long | AutoCompleteType parameter (nillable) |
| CreateWebMethodName | Optional | string | CreateWebMethodName parameter (nillable) |
| CreatedBy | Optional | long | CreatedBy parameter (nillable) |
| CreatedDate | Optional | dateTime | CreatedDate parameter |
| DefaultPageSize | Optional | int | DefaultPageSize parameter (nillable) |
| Deleted | Optional | boolean | Deleted parameter |
| Description | Optional | string | Description parameter (nillable) |
| DisplayEvents | Optional | boolean | DisplayEvents parameter |
| DisplayFormat | Optional | string | DisplayFormat parameter (nillable) |
| EntityTypeName | Optional | string | EntityTypeName parameter (nillable) |
| FriendlyName | Optional | string | FriendlyName parameter (nillable) |
| Hash | Optional | string | Hash parameter (nillable) |
| InterfaceTypeName | Optional | string | InterfaceTypeName parameter (nillable) |
| IsMobileAudited | Optional | boolean | IsMobileAudited parameter |
| MaxPageSize | Optional | int | MaxPageSize parameter (nillable) |
| MobileSystemAuditable | Optional | boolean | MobileSystemAuditable parameter |
| ModifiedBy | Optional | long | ModifiedBy parameter (nillable) |
| ModifiedDate | Optional | dateTime | ModifiedDate parameter |
| Name | Optional | string | Name parameter (nillable) |
| OffloadLongRunningTasks | Optional | boolean | OffloadLongRunningTasks parameter |
| OffloadThreshold | Optional | int | OffloadThreshold parameter (nillable) |
| PmsCoreValue | Optional | boolean | PmsCoreValue parameter |
| PublishDreamscapeData | Optional | boolean | PublishDreamscapeData parameter (nillable) |
| PublishMobileData | Optional | boolean | PublishMobileData parameter |
| ReadOnly | Optional | boolean | ReadOnly parameter |
| StoreAttributesAndProperties | Optional | boolean | StoreAttributesAndProperties parameter |
| StoreBimDocuments | Optional | boolean | StoreBimDocuments parameter |
| StoreDocuments | Optional | boolean | StoreDocuments parameter |
| TableCatalogId | Optional | long | TableCatalogId parameter (nillable) |
| Type | Optional | long | Type parameter (nillable) |
| UpdateWebMethodName | Optional | string | UpdateWebMethodName parameter (nillable) |
| Version | Optional | long | Version parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ConfigurationServiceClient())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new TableDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateTableCatalog(sessionId, impersonateAccountId, dto);
// Process the response
if (response != null)
{
// Handle successful response
Console.WriteLine("Operation completed successfully");
}
}
SOAP XML Example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:bas="http://basic.evolutionsvc.mriapi.com/">
<soap:Header/>
<soap:Body>
<bas:UpdateTableCatalog>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- TableDto properties here -->
</bas:dto>
</bas:UpdateTableCatalog>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConfigurationService.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object TableDto
# Call the service method
$result = $proxy.UpdateTableCatalog($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}