Web Service: ConceptDocumentServiceV3
Port ConceptDocumentServiceV3
- AssignBIMDocumentToEntityDetail
- AssignConceptDocumentToEntityDetail
- CreateConceptDocumentDetail
- CreateDocumentClassFromDtoDetail
- CreateDocumentSubClassFromDtoDetail
- GetBIMDocumentsByRepositoryIdDetail
- GetConceptDocumentsByRepositorIdDetail
- GetDocumentBufferDetail
- GetDocumentClassByIdDetail
- GetDocumentClassesDetail
- GetDocumentSubClassByIdDetail
- GetDocumentSubClassesDetail
- GetPublishedDocumentRepositoriesForLoggedInUserDetail
- UnAssignBIMDocumentFromEntityDetail
- UnAssignConceptDocumentFromEntityDetail
- UpdateDocumentClassByDtoDetail
- UpdateDocumentSubClassByDtoDetail
Port type IConceptDocumentServiceV3
1. AssignBIMDocumentToEntity
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConceptDocumentServiceV3_AssignBIMDocumentToEntity_InputMessage (soap:body, use = literal)
parameters type AssignBIMDocumentToEntity
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| request | Optional | BIMDocumentEntityAssignRequestDto | request 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
| BIMDocumentIds | Optional | ArrayOflong | BIMDocumentIds parameter (nillable) |
| long | Optional | long | long parameter |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter |
| ExternalController | Optional | boolean | ExternalController parameter (nillable) |
| IntegrationDate | Optional | dateTime | IntegrationDate parameter (nillable) |
| IntegrationIdentifier | Optional | string | IntegrationIdentifier parameter (nillable) |
| IntegrationObject | Optional | string | IntegrationObject parameter (nillable) |
| IntegrationSystem | Optional | string | IntegrationSystem parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter |
Output: IConceptDocumentServiceV3_AssignBIMDocumentToEntity_OutputMessage (soap:body, use = literal)
parameters type AssignBIMDocumentToEntityResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| AssignBIMDocumentToEntityResult | Optional | BIMDocumentEntityAssignResponseDto | AssignBIMDocumentToEntityResult 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
| BIMDocumentIds | Optional | ArrayOflong | BIMDocumentIds parameter (nillable) |
| long | Optional | long | long parameter |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter |
| ExternalController | Optional | boolean | ExternalController parameter (nillable) |
| IntegrationDate | Optional | dateTime | IntegrationDate parameter (nillable) |
| IntegrationIdentifier | Optional | string | IntegrationIdentifier parameter (nillable) |
| IntegrationObject | Optional | string | IntegrationObject parameter (nillable) |
| IntegrationSystem | Optional | string | IntegrationSystem parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter |
Code Examples
C# Example
// Create the service client
using (var client = new ConceptDocumentServiceV3Client())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var request = new BIMDocumentEntityAssignRequestDto
{
// Set DTO properties here
};
// Call the service method
var response = client.AssignBIMDocumentToEntity(sessionId, impersonateAccountId, request);
// 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:AssignBIMDocumentToEntity>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:request>
<!-- BIMDocumentEntityAssignRequestDto properties here -->
</bas:request>
</bas:AssignBIMDocumentToEntity>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConceptDocumentServiceV3.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$request = New-Object BIMDocumentEntityAssignRequestDto
# Call the service method
$result = $proxy.AssignBIMDocumentToEntity($sessionId, $impersonateAccountId, $request)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
2. AssignConceptDocumentToEntity
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConceptDocumentServiceV3_AssignConceptDocumentToEntity_InputMessage (soap:body, use = literal)
parameters type AssignConceptDocumentToEntity
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| request | Optional | ConceptDocumentEntityAssignRequestDto | request 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
| ConceptDocumentIds | Optional | ArrayOflong | ConceptDocumentIds parameter (nillable) |
| long | Optional | long | long parameter |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter |
| ExternalController | Optional | boolean | ExternalController parameter (nillable) |
| IntegrationDate | Optional | dateTime | IntegrationDate parameter (nillable) |
| IntegrationIdentifier | Optional | string | IntegrationIdentifier parameter (nillable) |
| IntegrationObject | Optional | string | IntegrationObject parameter (nillable) |
| IntegrationSystem | Optional | string | IntegrationSystem parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter |
Output: IConceptDocumentServiceV3_AssignConceptDocumentToEntity_OutputMessage (soap:body, use = literal)
parameters type AssignConceptDocumentToEntityResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| AssignConceptDocumentToEntityResult | Optional | ConceptDocumentEntityAssignResponseDto | AssignConceptDocumentToEntityResult 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
| ConceptDocumentIds | Optional | ArrayOflong | ConceptDocumentIds parameter (nillable) |
| long | Optional | long | long parameter |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter |
| ExternalController | Optional | boolean | ExternalController parameter (nillable) |
| IntegrationDate | Optional | dateTime | IntegrationDate parameter (nillable) |
| IntegrationIdentifier | Optional | string | IntegrationIdentifier parameter (nillable) |
| IntegrationObject | Optional | string | IntegrationObject parameter (nillable) |
| IntegrationSystem | Optional | string | IntegrationSystem parameter (nillable) |
| TableCatalogId | Optional | long | TableCatalogId parameter |
Code Examples
C# Example
// Create the service client
using (var client = new ConceptDocumentServiceV3Client())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var request = new ConceptDocumentEntityAssignRequestDto
{
// Set DTO properties here
};
// Call the service method
var response = client.AssignConceptDocumentToEntity(sessionId, impersonateAccountId, request);
// 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:AssignConceptDocumentToEntity>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:request>
<!-- ConceptDocumentEntityAssignRequestDto properties here -->
</bas:request>
</bas:AssignConceptDocumentToEntity>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConceptDocumentServiceV3.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$request = New-Object ConceptDocumentEntityAssignRequestDto
# Call the service method
$result = $proxy.AssignConceptDocumentToEntity($sessionId, $impersonateAccountId, $request)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
3. CreateConceptDocument
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConceptDocumentServiceV3_CreateConceptDocument_InputMessage (soap:body, use = literal)
parameters type CreateConceptDocument
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| request | Optional | ConceptDocumentRequestDtoV3 | request 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
| ActualPath | Optional | string | ActualPath parameter (nillable) |
| ActualPathJson | Optional | string | ActualPathJson parameter (nillable) |
| Author | Optional | string | Author parameter (nillable) |
| AvailableOnSsp | Optional | boolean | AvailableOnSsp parameter (nillable) |
| Buffer | Optional | base64Binary | Buffer parameter (nillable) |
| BufferJson | Optional | base64Binary | BufferJson parameter (nillable) |
| Category | Optional | string | Category parameter (nillable) |
| DocumentClassId | Optional | long | DocumentClassId parameter |
| DocumentEntityType | Optional | DocumentEntityType | ConceptDocument, BIMDocument, LoginBackgroundDocument |
| DocumentRef | Optional | string | DocumentRef parameter (nillable) |
| DocumentRepositoryId | Optional | long | DocumentRepositoryId parameter (nillable) |
| DocumentSubClassId | Optional | long | DocumentSubClassId parameter |
| DocumentType | Optional | DocumentTypes | Document, URL, BIM3DModel, IFC |
| DocumentVersion | Optional | int | DocumentVersion parameter (nillable) |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter |
| ExternalController | Optional | boolean | ExternalController parameter (nillable) |
| FileName | Optional | string | FileName parameter (nillable) |
| IntegrationDate | Optional | dateTime | IntegrationDate parameter (nillable) |
| IntegrationIdentifier | Optional | string | IntegrationIdentifier parameter (nillable) |
| IntegrationObject | Optional | string | IntegrationObject parameter (nillable) |
| IntegrationSystem | Optional | string | IntegrationSystem parameter (nillable) |
| Keywords | Optional | string | Keywords parameter (nillable) |
| Notes | Optional | string | Notes parameter (nillable) |
| Subject | Optional | string | Subject parameter (nillable) |
| Title | Optional | string | Title parameter (nillable) |
Output: IConceptDocumentServiceV3_CreateConceptDocument_OutputMessage (soap:body, use = literal)
parameters type CreateConceptDocumentResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateConceptDocumentResult | Optional | ConceptDocumentResponseDtoV3 | CreateConceptDocumentResult 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
| ActualPath | Optional | string | ActualPath parameter (nillable) |
| ActualPathJson | Optional | string | ActualPathJson parameter (nillable) |
| Author | Optional | string | Author parameter (nillable) |
| AvailableOnSsp | Optional | boolean | AvailableOnSsp parameter |
| Buffer | Optional | base64Binary | Buffer parameter (nillable) |
| BufferJson | Optional | base64Binary | BufferJson parameter (nillable) |
| Category | Optional | string | Category parameter (nillable) |
| ConceptDocumentId | Optional | long | ConceptDocumentId parameter |
| CreatedBy | Optional | long | CreatedBy parameter |
| CreatedDate | Optional | dateTime | CreatedDate parameter |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| DocumentClassId | Optional | long | DocumentClassId parameter |
| DocumentEntityType | Optional | DocumentEntityType | ConceptDocument, BIMDocument, LoginBackgroundDocument |
| DocumentFileTypeId | Optional | long | DocumentFileTypeId parameter |
| DocumentRef | Optional | string | DocumentRef parameter (nillable) |
| DocumentRepositoryId | Optional | long | DocumentRepositoryId parameter |
| DocumentSubClassId | Optional | long | DocumentSubClassId parameter |
| DocumentType | Optional | DocumentTypes | Document, URL, BIM3DModel, IFC |
| DocumentVersion | Optional | long | DocumentVersion parameter |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter |
| ExternalController | Optional | boolean | ExternalController parameter (nillable) |
| FileName | Optional | string | FileName parameter (nillable) |
| IntegrationDate | Optional | dateTime | IntegrationDate parameter (nillable) |
| IntegrationIdentifier | Optional | string | IntegrationIdentifier parameter (nillable) |
| IntegrationObject | Optional | string | IntegrationObject parameter (nillable) |
| IntegrationSystem | Optional | string | IntegrationSystem parameter (nillable) |
| IsTemporary | Optional | boolean | IsTemporary parameter |
| Keywords | Optional | string | Keywords parameter (nillable) |
| LastUploadedBy | Optional | long | LastUploadedBy parameter |
| LastUploadedDateUtc | Optional | dateTime | LastUploadedDateUtc parameter |
| ModifiedBy | Optional | long | ModifiedBy parameter |
| ModifiedDate | Optional | dateTime | ModifiedDate parameter |
| Notes | Optional | string | Notes parameter (nillable) |
| NumberOfTimesUploaded | Optional | long | NumberOfTimesUploaded parameter |
| Status | Optional | int | Status parameter |
| StorageMode | Optional | DocumentStorageMode | Disk, Database, AzureFileStorage, AzureBlobStorage |
| Subject | Optional | string | Subject parameter (nillable) |
| Title | Optional | string | Title parameter (nillable) |
| Version | Optional | long | Version parameter |
Code Examples
C# Example
// Create the service client
using (var client = new ConceptDocumentServiceV3Client())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var request = new ConceptDocumentRequestDtoV3
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateConceptDocument(sessionId, impersonateAccountId, request);
// 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:CreateConceptDocument>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:request>
<!-- ConceptDocumentRequestDtoV3 properties here -->
</bas:request>
</bas:CreateConceptDocument>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConceptDocumentServiceV3.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$request = New-Object ConceptDocumentRequestDtoV3
# Call the service method
$result = $proxy.CreateConceptDocument($sessionId, $impersonateAccountId, $request)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
4. CreateDocumentClassFromDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConceptDocumentServiceV3_CreateDocumentClassFromDto_InputMessage (soap:body, use = literal)
parameters type CreateDocumentClassFromDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | DocumentClassDto | 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
| CreatedBy | Optional | long | CreatedBy parameter (nillable) |
| CreatedDate | Optional | dateTime | CreatedDate parameter |
| Deleted | Optional | boolean | Deleted parameter |
| DocumentClassId | Optional | long | DocumentClassId parameter (nillable) |
| ModifiedBy | Optional | long | ModifiedBy parameter (nillable) |
| ModifiedDate | Optional | dateTime | ModifiedDate parameter |
| Name | Optional | string | Name parameter (nillable) |
| Version | Optional | long | Version parameter (nillable) |
Output: IConceptDocumentServiceV3_CreateDocumentClassFromDto_OutputMessage (soap:body, use = literal)
parameters type CreateDocumentClassFromDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateDocumentClassFromDtoResult | Optional | DocumentClassDto | CreateDocumentClassFromDtoResult 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
| CreatedBy | Optional | long | CreatedBy parameter (nillable) |
| CreatedDate | Optional | dateTime | CreatedDate parameter |
| Deleted | Optional | boolean | Deleted parameter |
| DocumentClassId | Optional | long | DocumentClassId parameter (nillable) |
| ModifiedBy | Optional | long | ModifiedBy parameter (nillable) |
| ModifiedDate | Optional | dateTime | ModifiedDate parameter |
| Name | Optional | string | Name parameter (nillable) |
| Version | Optional | long | Version parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ConceptDocumentServiceV3Client())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new DocumentClassDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateDocumentClassFromDto(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:CreateDocumentClassFromDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- DocumentClassDto properties here -->
</bas:dto>
</bas:CreateDocumentClassFromDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConceptDocumentServiceV3.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object DocumentClassDto
# Call the service method
$result = $proxy.CreateDocumentClassFromDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
5. CreateDocumentSubClassFromDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConceptDocumentServiceV3_CreateDocumentSubClassFromDto_InputMessage (soap:body, use = literal)
parameters type CreateDocumentSubClassFromDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | DocumentSubClassDto | 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
| CreatedBy | Optional | long | CreatedBy parameter (nillable) |
| CreatedDate | Optional | dateTime | CreatedDate parameter |
| Deleted | Optional | boolean | Deleted parameter |
| DocumentClassId | Optional | long | DocumentClassId parameter (nillable) |
| DocumentSubClassId | Optional | long | DocumentSubClassId parameter (nillable) |
| ModifiedBy | Optional | long | ModifiedBy parameter (nillable) |
| ModifiedDate | Optional | dateTime | ModifiedDate parameter |
| Name | Optional | string | Name parameter (nillable) |
| Version | Optional | long | Version parameter (nillable) |
Output: IConceptDocumentServiceV3_CreateDocumentSubClassFromDto_OutputMessage (soap:body, use = literal)
parameters type CreateDocumentSubClassFromDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| CreateDocumentSubClassFromDtoResult | Optional | DocumentSubClassDto | CreateDocumentSubClassFromDtoResult 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
| CreatedBy | Optional | long | CreatedBy parameter (nillable) |
| CreatedDate | Optional | dateTime | CreatedDate parameter |
| Deleted | Optional | boolean | Deleted parameter |
| DocumentClassId | Optional | long | DocumentClassId parameter (nillable) |
| DocumentSubClassId | Optional | long | DocumentSubClassId parameter (nillable) |
| ModifiedBy | Optional | long | ModifiedBy parameter (nillable) |
| ModifiedDate | Optional | dateTime | ModifiedDate parameter |
| Name | Optional | string | Name parameter (nillable) |
| Version | Optional | long | Version parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ConceptDocumentServiceV3Client())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new DocumentSubClassDto
{
// Set DTO properties here
};
// Call the service method
var response = client.CreateDocumentSubClassFromDto(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:CreateDocumentSubClassFromDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- DocumentSubClassDto properties here -->
</bas:dto>
</bas:CreateDocumentSubClassFromDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConceptDocumentServiceV3.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object DocumentSubClassDto
# Call the service method
$result = $proxy.CreateDocumentSubClassFromDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
6. GetBIMDocumentsByRepositoryId
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConceptDocumentServiceV3_GetBIMDocumentsByRepositoryId_InputMessage (soap:body, use = literal)
parameters type GetBIMDocumentsByRepositoryId
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| id | Optional | long | id parameter |
| fileTypeEx | Optional | string | fileTypeEx parameter (nillable) |
Output: IConceptDocumentServiceV3_GetBIMDocumentsByRepositoryId_OutputMessage (soap:body, use = literal)
parameters type GetBIMDocumentsByRepositoryIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetBIMDocumentsByRepositoryIdResult | Optional | ArrayOfConceptDocumentResponseDtoV3 | GetBIMDocumentsByRepositoryIdResult parameter (nillable) |
| ConceptDocumentResponseDtoV3 | Optional | ConceptDocumentResponseDtoV3 | ConceptDocumentResponseDtoV3 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
| ActualPath | Optional | string | ActualPath parameter (nillable) |
| ActualPathJson | Optional | string | ActualPathJson parameter (nillable) |
| Author | Optional | string | Author parameter (nillable) |
| AvailableOnSsp | Optional | boolean | AvailableOnSsp parameter |
| Buffer | Optional | base64Binary | Buffer parameter (nillable) |
| BufferJson | Optional | base64Binary | BufferJson parameter (nillable) |
| Category | Optional | string | Category parameter (nillable) |
| ConceptDocumentId | Optional | long | ConceptDocumentId parameter |
| CreatedBy | Optional | long | CreatedBy parameter |
| CreatedDate | Optional | dateTime | CreatedDate parameter |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| DocumentClassId | Optional | long | DocumentClassId parameter |
| DocumentEntityType | Optional | DocumentEntityType | ConceptDocument, BIMDocument, LoginBackgroundDocument |
| DocumentFileTypeId | Optional | long | DocumentFileTypeId parameter |
| DocumentRef | Optional | string | DocumentRef parameter (nillable) |
| DocumentRepositoryId | Optional | long | DocumentRepositoryId parameter |
| DocumentSubClassId | Optional | long | DocumentSubClassId parameter |
| DocumentType | Optional | DocumentTypes | Document, URL, BIM3DModel, IFC |
| DocumentVersion | Optional | long | DocumentVersion parameter |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter |
| ExternalController | Optional | boolean | ExternalController parameter (nillable) |
| FileName | Optional | string | FileName parameter (nillable) |
| IntegrationDate | Optional | dateTime | IntegrationDate parameter (nillable) |
| IntegrationIdentifier | Optional | string | IntegrationIdentifier parameter (nillable) |
| IntegrationObject | Optional | string | IntegrationObject parameter (nillable) |
| IntegrationSystem | Optional | string | IntegrationSystem parameter (nillable) |
| IsTemporary | Optional | boolean | IsTemporary parameter |
| Keywords | Optional | string | Keywords parameter (nillable) |
| LastUploadedBy | Optional | long | LastUploadedBy parameter |
| LastUploadedDateUtc | Optional | dateTime | LastUploadedDateUtc parameter |
| ModifiedBy | Optional | long | ModifiedBy parameter |
| ModifiedDate | Optional | dateTime | ModifiedDate parameter |
| Notes | Optional | string | Notes parameter (nillable) |
| NumberOfTimesUploaded | Optional | long | NumberOfTimesUploaded parameter |
| Status | Optional | int | Status parameter |
| StorageMode | Optional | DocumentStorageMode | Disk, Database, AzureFileStorage, AzureBlobStorage |
| Subject | Optional | string | Subject parameter (nillable) |
| Title | Optional | string | Title parameter (nillable) |
| Version | Optional | long | Version parameter |
Code Examples
C# Example
// Create the service client
using (var client = new ConceptDocumentServiceV3Client())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long id = 123;
// Call the service method
var response = client.GetBIMDocumentsByRepositoryId(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:GetBIMDocumentsByRepositoryId>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:id>123</bas:id>
</bas:GetBIMDocumentsByRepositoryId>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConceptDocumentServiceV3.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$id = 123
# Call the service method
$result = $proxy.GetBIMDocumentsByRepositoryId($sessionId, $impersonateAccountId, $id)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
7. GetConceptDocumentsByRepositorId
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConceptDocumentServiceV3_GetConceptDocumentsByRepositorId_InputMessage (soap:body, use = literal)
parameters type GetConceptDocumentsByRepositorId
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| id | Optional | long | id parameter |
| fileTypeEx | Optional | string | fileTypeEx parameter (nillable) |
Output: IConceptDocumentServiceV3_GetConceptDocumentsByRepositorId_OutputMessage (soap:body, use = literal)
parameters type GetConceptDocumentsByRepositorIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetConceptDocumentsByRepositorIdResult | Optional | ArrayOfConceptDocumentResponseDtoV3 | GetConceptDocumentsByRepositorIdResult parameter (nillable) |
| ConceptDocumentResponseDtoV3 | Optional | ConceptDocumentResponseDtoV3 | ConceptDocumentResponseDtoV3 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
| ActualPath | Optional | string | ActualPath parameter (nillable) |
| ActualPathJson | Optional | string | ActualPathJson parameter (nillable) |
| Author | Optional | string | Author parameter (nillable) |
| AvailableOnSsp | Optional | boolean | AvailableOnSsp parameter |
| Buffer | Optional | base64Binary | Buffer parameter (nillable) |
| BufferJson | Optional | base64Binary | BufferJson parameter (nillable) |
| Category | Optional | string | Category parameter (nillable) |
| ConceptDocumentId | Optional | long | ConceptDocumentId parameter |
| CreatedBy | Optional | long | CreatedBy parameter |
| CreatedDate | Optional | dateTime | CreatedDate parameter |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| DocumentClassId | Optional | long | DocumentClassId parameter |
| DocumentEntityType | Optional | DocumentEntityType | ConceptDocument, BIMDocument, LoginBackgroundDocument |
| DocumentFileTypeId | Optional | long | DocumentFileTypeId parameter |
| DocumentRef | Optional | string | DocumentRef parameter (nillable) |
| DocumentRepositoryId | Optional | long | DocumentRepositoryId parameter |
| DocumentSubClassId | Optional | long | DocumentSubClassId parameter |
| DocumentType | Optional | DocumentTypes | Document, URL, BIM3DModel, IFC |
| DocumentVersion | Optional | long | DocumentVersion parameter |
| ExpiryDateUtc | Optional | dateTime | ExpiryDateUtc parameter |
| ExternalController | Optional | boolean | ExternalController parameter (nillable) |
| FileName | Optional | string | FileName parameter (nillable) |
| IntegrationDate | Optional | dateTime | IntegrationDate parameter (nillable) |
| IntegrationIdentifier | Optional | string | IntegrationIdentifier parameter (nillable) |
| IntegrationObject | Optional | string | IntegrationObject parameter (nillable) |
| IntegrationSystem | Optional | string | IntegrationSystem parameter (nillable) |
| IsTemporary | Optional | boolean | IsTemporary parameter |
| Keywords | Optional | string | Keywords parameter (nillable) |
| LastUploadedBy | Optional | long | LastUploadedBy parameter |
| LastUploadedDateUtc | Optional | dateTime | LastUploadedDateUtc parameter |
| ModifiedBy | Optional | long | ModifiedBy parameter |
| ModifiedDate | Optional | dateTime | ModifiedDate parameter |
| Notes | Optional | string | Notes parameter (nillable) |
| NumberOfTimesUploaded | Optional | long | NumberOfTimesUploaded parameter |
| Status | Optional | int | Status parameter |
| StorageMode | Optional | DocumentStorageMode | Disk, Database, AzureFileStorage, AzureBlobStorage |
| Subject | Optional | string | Subject parameter (nillable) |
| Title | Optional | string | Title parameter (nillable) |
| Version | Optional | long | Version parameter |
Code Examples
C# Example
// Create the service client
using (var client = new ConceptDocumentServiceV3Client())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long id = 123;
// Call the service method
var response = client.GetConceptDocumentsByRepositorId(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:GetConceptDocumentsByRepositorId>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:id>123</bas:id>
</bas:GetConceptDocumentsByRepositorId>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConceptDocumentServiceV3.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$id = 123
# Call the service method
$result = $proxy.GetConceptDocumentsByRepositorId($sessionId, $impersonateAccountId, $id)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
8. GetDocumentBuffer
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConceptDocumentServiceV3_GetDocumentBuffer_InputMessage (soap:body, use = literal)
parameters type GetDocumentBuffer
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| documentId | Optional | long | documentId parameter |
Output: IConceptDocumentServiceV3_GetDocumentBuffer_OutputMessage (soap:body, use = literal)
parameters type GetDocumentBufferResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetDocumentBufferResult | Optional | base64Binary | GetDocumentBufferResult parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ConceptDocumentServiceV3Client())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long documentId = 123;
// Call the service method
var response = client.GetDocumentBuffer(sessionId, impersonateAccountId, documentId);
// 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:GetDocumentBuffer>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:documentId>123</bas:documentId>
</bas:GetDocumentBuffer>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConceptDocumentServiceV3.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$documentId = 123
# Call the service method
$result = $proxy.GetDocumentBuffer($sessionId, $impersonateAccountId, $documentId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
9. GetDocumentClassById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConceptDocumentServiceV3_GetDocumentClassById_InputMessage (soap:body, use = literal)
parameters type GetDocumentClassById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Output: IConceptDocumentServiceV3_GetDocumentClassById_OutputMessage (soap:body, use = literal)
parameters type GetDocumentClassByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetDocumentClassByIdResult | Optional | DocumentClassDto | GetDocumentClassByIdResult 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
| CreatedBy | Optional | long | CreatedBy parameter (nillable) |
| CreatedDate | Optional | dateTime | CreatedDate parameter |
| Deleted | Optional | boolean | Deleted parameter |
| DocumentClassId | Optional | long | DocumentClassId parameter (nillable) |
| ModifiedBy | Optional | long | ModifiedBy parameter (nillable) |
| ModifiedDate | Optional | dateTime | ModifiedDate parameter |
| Name | Optional | string | Name parameter (nillable) |
| Version | Optional | long | Version parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ConceptDocumentServiceV3Client())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.GetDocumentClassById(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:GetDocumentClassById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:GetDocumentClassById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConceptDocumentServiceV3.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.GetDocumentClassById($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
10. GetDocumentClasses
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConceptDocumentServiceV3_GetDocumentClasses_InputMessage (soap:body, use = literal)
parameters type GetDocumentClasses
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| documentClassId | Optional | long | documentClassId parameter |
Output: IConceptDocumentServiceV3_GetDocumentClasses_OutputMessage (soap:body, use = literal)
parameters type GetDocumentClassesResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetDocumentClassesResult | Optional | ArrayOfDocumentClassDto | GetDocumentClassesResult parameter (nillable) |
| DocumentClassDto | Optional | DocumentClassDto | DocumentClassDto 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
| CreatedBy | Optional | long | CreatedBy parameter (nillable) |
| CreatedDate | Optional | dateTime | CreatedDate parameter |
| Deleted | Optional | boolean | Deleted parameter |
| DocumentClassId | Optional | long | DocumentClassId parameter (nillable) |
| ModifiedBy | Optional | long | ModifiedBy parameter (nillable) |
| ModifiedDate | Optional | dateTime | ModifiedDate parameter |
| Name | Optional | string | Name parameter (nillable) |
| Version | Optional | long | Version parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ConceptDocumentServiceV3Client())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long documentClassId = 123;
// Call the service method
var response = client.GetDocumentClasses(sessionId, impersonateAccountId, documentClassId);
// 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:GetDocumentClasses>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:documentClassId>123</bas:documentClassId>
</bas:GetDocumentClasses>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConceptDocumentServiceV3.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$documentClassId = 123
# Call the service method
$result = $proxy.GetDocumentClasses($sessionId, $impersonateAccountId, $documentClassId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
11. GetDocumentSubClassById
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConceptDocumentServiceV3_GetDocumentSubClassById_InputMessage (soap:body, use = literal)
parameters type GetDocumentSubClassById
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| entityId | Optional | long | entityId parameter |
Output: IConceptDocumentServiceV3_GetDocumentSubClassById_OutputMessage (soap:body, use = literal)
parameters type GetDocumentSubClassByIdResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetDocumentSubClassByIdResult | Optional | DocumentSubClassDto | GetDocumentSubClassByIdResult 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
| CreatedBy | Optional | long | CreatedBy parameter (nillable) |
| CreatedDate | Optional | dateTime | CreatedDate parameter |
| Deleted | Optional | boolean | Deleted parameter |
| DocumentClassId | Optional | long | DocumentClassId parameter (nillable) |
| DocumentSubClassId | Optional | long | DocumentSubClassId parameter (nillable) |
| ModifiedBy | Optional | long | ModifiedBy parameter (nillable) |
| ModifiedDate | Optional | dateTime | ModifiedDate parameter |
| Name | Optional | string | Name parameter (nillable) |
| Version | Optional | long | Version parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ConceptDocumentServiceV3Client())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long entityId = 123;
// Call the service method
var response = client.GetDocumentSubClassById(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:GetDocumentSubClassById>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:entityId>123</bas:entityId>
</bas:GetDocumentSubClassById>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConceptDocumentServiceV3.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$entityId = 123
# Call the service method
$result = $proxy.GetDocumentSubClassById($sessionId, $impersonateAccountId, $entityId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
12. GetDocumentSubClasses
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConceptDocumentServiceV3_GetDocumentSubClasses_InputMessage (soap:body, use = literal)
parameters type GetDocumentSubClasses
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| documentClassId | Optional | long | documentClassId parameter |
Output: IConceptDocumentServiceV3_GetDocumentSubClasses_OutputMessage (soap:body, use = literal)
parameters type GetDocumentSubClassesResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetDocumentSubClassesResult | Optional | ArrayOfDocumentSubClassDto | GetDocumentSubClassesResult parameter (nillable) |
| DocumentSubClassDto | Optional | DocumentSubClassDto | DocumentSubClassDto 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
| CreatedBy | Optional | long | CreatedBy parameter (nillable) |
| CreatedDate | Optional | dateTime | CreatedDate parameter |
| Deleted | Optional | boolean | Deleted parameter |
| DocumentClassId | Optional | long | DocumentClassId parameter (nillable) |
| DocumentSubClassId | Optional | long | DocumentSubClassId parameter (nillable) |
| ModifiedBy | Optional | long | ModifiedBy parameter (nillable) |
| ModifiedDate | Optional | dateTime | ModifiedDate parameter |
| Name | Optional | string | Name parameter (nillable) |
| Version | Optional | long | Version parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ConceptDocumentServiceV3Client())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
long documentClassId = 123;
// Call the service method
var response = client.GetDocumentSubClasses(sessionId, impersonateAccountId, documentClassId);
// 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:GetDocumentSubClasses>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:documentClassId>123</bas:documentClassId>
</bas:GetDocumentSubClasses>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConceptDocumentServiceV3.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$documentClassId = 123
# Call the service method
$result = $proxy.GetDocumentSubClasses($sessionId, $impersonateAccountId, $documentClassId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
13. GetPublishedDocumentRepositoriesForLoggedInUser
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConceptDocumentServiceV3_GetPublishedDocumentRepositoriesForLoggedInUser_InputMessage (soap:body, use = literal)
parameters type GetPublishedDocumentRepositoriesForLoggedInUser
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
Output: IConceptDocumentServiceV3_GetPublishedDocumentRepositoriesForLoggedInUser_OutputMessage (soap:body, use = literal)
parameters type GetPublishedDocumentRepositoriesForLoggedInUserResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| GetPublishedDocumentRepositoriesForLoggedInUserResult | Optional | ArrayOfDocumentRepositoryResponseDto | GetPublishedDocumentRepositoriesForLoggedInUserResult parameter (nillable) |
| DocumentRepositoryResponseDto | Optional | DocumentRepositoryResponseDto | DocumentRepositoryResponseDto 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
| DirectPrintingStore | Optional | boolean | DirectPrintingStore parameter |
| DisplayText | Optional | string | DisplayText parameter (nillable) |
| DocumentRepositoryId | Optional | long | DocumentRepositoryId parameter |
| IsBimDefault | Optional | boolean | IsBimDefault parameter |
| IsDefault | Optional | boolean | IsDefault parameter |
| MaxFileSizeMB | Optional | double | MaxFileSizeMB parameter |
| Name | Optional | string | Name parameter (nillable) |
| OffloadResultsStore | Optional | boolean | OffloadResultsStore parameter |
| RootPath | Optional | string | RootPath parameter (nillable) |
| StorageMode | Optional | DocumentStorageMode | Disk, Database, AzureFileStorage, AzureBlobStorage |
| SurveyResponseStore | Optional | boolean | SurveyResponseStore parameter |
Code Examples
C# Example
// Create the service client
using (var client = new ConceptDocumentServiceV3Client())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
// Call the service method
var response = client.GetPublishedDocumentRepositoriesForLoggedInUser(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:GetPublishedDocumentRepositoriesForLoggedInUser>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
</bas:GetPublishedDocumentRepositoriesForLoggedInUser>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConceptDocumentServiceV3.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
# Call the service method
$result = $proxy.GetPublishedDocumentRepositoriesForLoggedInUser($sessionId, $impersonateAccountId)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
14. UnAssignBIMDocumentFromEntity
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConceptDocumentServiceV3_UnAssignBIMDocumentFromEntity_InputMessage (soap:body, use = literal)
parameters type UnAssignBIMDocumentFromEntity
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| request | Optional | BIMDocumentEntityUnAssignRequestDto | request 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
| BIMDocumentIds | Optional | ArrayOflong | BIMDocumentIds parameter (nillable) |
| long | Optional | long | long parameter |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter |
| TableCatalogId | Optional | long | TableCatalogId parameter |
Output: IConceptDocumentServiceV3_UnAssignBIMDocumentFromEntity_OutputMessage (soap:body, use = literal)
parameters type UnAssignBIMDocumentFromEntityResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UnAssignBIMDocumentFromEntityResult | Optional | BIMDocumentEntityUnAssignResponseDto | UnAssignBIMDocumentFromEntityResult 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
Code Examples
C# Example
// Create the service client
using (var client = new ConceptDocumentServiceV3Client())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var request = new BIMDocumentEntityUnAssignRequestDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UnAssignBIMDocumentFromEntity(sessionId, impersonateAccountId, request);
// 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:UnAssignBIMDocumentFromEntity>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:request>
<!-- BIMDocumentEntityUnAssignRequestDto properties here -->
</bas:request>
</bas:UnAssignBIMDocumentFromEntity>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConceptDocumentServiceV3.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$request = New-Object BIMDocumentEntityUnAssignRequestDto
# Call the service method
$result = $proxy.UnAssignBIMDocumentFromEntity($sessionId, $impersonateAccountId, $request)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
15. UnAssignConceptDocumentFromEntity
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConceptDocumentServiceV3_UnAssignConceptDocumentFromEntity_InputMessage (soap:body, use = literal)
parameters type UnAssignConceptDocumentFromEntity
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| request | Optional | ConceptDocumentEntityUnAssignRequestDto | request 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
| ConceptDocumentIds | Optional | ArrayOflong | ConceptDocumentIds parameter (nillable) |
| long | Optional | long | long parameter |
| EntityPrimaryKeyId | Optional | long | EntityPrimaryKeyId parameter |
| TableCatalogId | Optional | long | TableCatalogId parameter |
Output: IConceptDocumentServiceV3_UnAssignConceptDocumentFromEntity_OutputMessage (soap:body, use = literal)
parameters type UnAssignConceptDocumentFromEntityResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UnAssignConceptDocumentFromEntityResult | Optional | ConceptDocumentEntityUnAssignResponseDto | UnAssignConceptDocumentFromEntityResult 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
Code Examples
C# Example
// Create the service client
using (var client = new ConceptDocumentServiceV3Client())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var request = new ConceptDocumentEntityUnAssignRequestDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UnAssignConceptDocumentFromEntity(sessionId, impersonateAccountId, request);
// 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:UnAssignConceptDocumentFromEntity>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:request>
<!-- ConceptDocumentEntityUnAssignRequestDto properties here -->
</bas:request>
</bas:UnAssignConceptDocumentFromEntity>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConceptDocumentServiceV3.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$request = New-Object ConceptDocumentEntityUnAssignRequestDto
# Call the service method
$result = $proxy.UnAssignConceptDocumentFromEntity($sessionId, $impersonateAccountId, $request)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
16. UpdateDocumentClassByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConceptDocumentServiceV3_UpdateDocumentClassByDto_InputMessage (soap:body, use = literal)
parameters type UpdateDocumentClassByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | DocumentClassDto | 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
| CreatedBy | Optional | long | CreatedBy parameter (nillable) |
| CreatedDate | Optional | dateTime | CreatedDate parameter |
| Deleted | Optional | boolean | Deleted parameter |
| DocumentClassId | Optional | long | DocumentClassId parameter (nillable) |
| ModifiedBy | Optional | long | ModifiedBy parameter (nillable) |
| ModifiedDate | Optional | dateTime | ModifiedDate parameter |
| Name | Optional | string | Name parameter (nillable) |
| Version | Optional | long | Version parameter (nillable) |
Output: IConceptDocumentServiceV3_UpdateDocumentClassByDto_OutputMessage (soap:body, use = literal)
parameters type UpdateDocumentClassByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateDocumentClassByDtoResult | Optional | DocumentClassDto | UpdateDocumentClassByDtoResult 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
| CreatedBy | Optional | long | CreatedBy parameter (nillable) |
| CreatedDate | Optional | dateTime | CreatedDate parameter |
| Deleted | Optional | boolean | Deleted parameter |
| DocumentClassId | Optional | long | DocumentClassId parameter (nillable) |
| ModifiedBy | Optional | long | ModifiedBy parameter (nillable) |
| ModifiedDate | Optional | dateTime | ModifiedDate parameter |
| Name | Optional | string | Name parameter (nillable) |
| Version | Optional | long | Version parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ConceptDocumentServiceV3Client())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new DocumentClassDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateDocumentClassByDto(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:UpdateDocumentClassByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- DocumentClassDto properties here -->
</bas:dto>
</bas:UpdateDocumentClassByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConceptDocumentServiceV3.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object DocumentClassDto
# Call the service method
$result = $proxy.UpdateDocumentClassByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}
17. UpdateDocumentSubClassByDto
Style: document
Operation type: Request-response. The endpoint receives a message, and sends a correlated message.
Input: IConceptDocumentServiceV3_UpdateDocumentSubClassByDto_InputMessage (soap:body, use = literal)
parameters type UpdateDocumentSubClassByDto
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| sessionId | Optional | string | sessionId parameter (nillable) |
| impersonateAccountId | Optional | long | impersonateAccountId parameter (nillable) |
| dto | Optional | DocumentSubClassDto | 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
| CreatedBy | Optional | long | CreatedBy parameter (nillable) |
| CreatedDate | Optional | dateTime | CreatedDate parameter |
| Deleted | Optional | boolean | Deleted parameter |
| DocumentClassId | Optional | long | DocumentClassId parameter (nillable) |
| DocumentSubClassId | Optional | long | DocumentSubClassId parameter (nillable) |
| ModifiedBy | Optional | long | ModifiedBy parameter (nillable) |
| ModifiedDate | Optional | dateTime | ModifiedDate parameter |
| Name | Optional | string | Name parameter (nillable) |
| Version | Optional | long | Version parameter (nillable) |
Output: IConceptDocumentServiceV3_UpdateDocumentSubClassByDto_OutputMessage (soap:body, use = literal)
parameters type UpdateDocumentSubClassByDtoResponse
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| UpdateDocumentSubClassByDtoResult | Optional | DocumentSubClassDto | UpdateDocumentSubClassByDtoResult 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 |
| ErrorCode | Optional | string | ErrorCode parameter (nillable) |
| HasErrors | Optional | boolean | HasErrors parameter |
| CreatedBy | Optional | long | CreatedBy parameter (nillable) |
| CreatedDate | Optional | dateTime | CreatedDate parameter |
| Deleted | Optional | boolean | Deleted parameter |
| DocumentClassId | Optional | long | DocumentClassId parameter (nillable) |
| DocumentSubClassId | Optional | long | DocumentSubClassId parameter (nillable) |
| ModifiedBy | Optional | long | ModifiedBy parameter (nillable) |
| ModifiedDate | Optional | dateTime | ModifiedDate parameter |
| Name | Optional | string | Name parameter (nillable) |
| Version | Optional | long | Version parameter (nillable) |
Code Examples
C# Example
// Create the service client
using (var client = new ConceptDocumentServiceV3Client())
{
// Create the request parameters
string sessionId = "your_value_here";
long impersonateAccountId = 123;
var dto = new DocumentSubClassDto
{
// Set DTO properties here
};
// Call the service method
var response = client.UpdateDocumentSubClassByDto(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:UpdateDocumentSubClassByDto>
<bas:sessionId>sample_value</bas:sessionId>
<bas:impersonateAccountId>123</bas:impersonateAccountId>
<bas:dto>
<!-- DocumentSubClassDto properties here -->
</bas:dto>
</bas:UpdateDocumentSubClassByDto>
</soap:Body>
</soap:Envelope>
PowerShell Example
# Create web service proxy
$serviceUrl = "http://your-evolution-site.com/Services/Basic/ConceptDocumentServiceV3.svc?wsdl"
$proxy = New-WebServiceProxy -Uri $serviceUrl
# Set parameters
$sessionId = "your_value_here"
$impersonateAccountId = 123
$dto = New-Object DocumentSubClassDto
# Call the service method
$result = $proxy.UpdateDocumentSubClassByDto($sessionId, $impersonateAccountId, $dto)
# Process the result
if ($result) {
Write-Host "Operation completed successfully"
$result | Format-List
}