Web Service Samples

The sample request and response XML files of web services are available in each folder specific to the web service. To access the folder, navigate to the Tools menu, click Configuration Viewer. The Configuration Viewer page is displayed. Click common > standard > samples and download schemas.zip. Extract the schemas.zip file and go to schemas/home/mdmuser/tibco/mdm/version/schema/DataService/2.0/samples

The following table lists the web services’ sample files and their locations:

Web Service Samples
Web Service Name Location Request and Response Files
Record Query schemas/home/mdmuser/tibco/mdm/version/schema/DataService/2.0/samples/repository/record-query 
MasterCatalogRecord-QueryData-Request.xmlMasterCatalogRecord-QueryData-Response.xml
Record Query Metadata   
MasterCatalogRecord-Query-Metadata-Request.xmlMasterCatalogRecord-Query-Metadata-Response.xml
Record Query ValidValues (Init)   
MasterCatalogRecord-Query-ValidValues-Request.xmlMasterCatalogRecord-Query-ValidValues-Response.xml
Record Validate    
Record Add or Modify schemas/home/mdmuser/tibco/mdm/version/schema/DataService/2.0/samples/repository/record-add_modify_delete 
MasterCatalogRecord-Add-Request.xmlMasterCatalogRecord-Add-Response.xml
Record Delete   
MasterCatalogRecord-QueryData-Deleted-Request.xmlMasterCatalogRecord-QueryData-Deleted-Response.xml
Initiate Workflow schemas/home/mdmuser/tibco/mdm/version/schema/DataService/2.0/samples/repository/record-add_modify_delete 
MasterCatalogRecord-InitiateWorkflow-Request.xmlMasterCatalogRecord-InitiateWorkflow-Response.xml
Process Records schemas/home/mdmuser/tibco/mdm/version/schema/DataService/2.0/samples/processrecords 
processRecords_success_allinputs-request.xmlprocessRecords_success-response.xmlprocessRecords_undefined_datasource-request.xmlprocessRecords-undefined_datasource-response.xmlprocessRecords_undefined_inputmap-request.xmlprocessRecords_undefined_inputmap-response.xmlprocessRecords_no_permission-response.xml
Work Item Query Parameters schemas/home/mdmuser/tibco/mdm/version/schema/DataService/2.0/samples/repository/workitem
  • Workitem-Query-Parameter-Request.xml
  • Workitem-Query-Parameter-Response.xml
Work Item Query
  • Workitem-Query-Request.xml
  • Workitem-Query-Response.xml
Work Item Modify Close
  • Workitem-Modify-CloseAll-Request.xml
  • Workitem-Modify-CloseAll-Response.xml
Work Item Lock
  • WorkItem-Lock-Request.xml
  • WorkItem-Lock-Response.xml
Work Item Unlock
  • WorkItem-UnLock-Request.xml
  • WorkItem-UnLock-Response.xml
Get Work Item
  • Workitem-Get-Request.xml
  • Workitem-Get-Response.xml
Work Item Reassign  
  • WorkItem-Reassign-Request.xml
  • WorkItem-Reassign-Response.xml
Get Custom Work Item Summary schemas/home/mdmuser/tibco/mdm/version/schema/DataService/2.0/samples/repository/workitem/workitemsummary For a single custom work item summary
  • GetCustomWorkitemSummary-request.xml
  • GetCustomWorkitemSummary-response.xml
  For multiple custom work item summary
  • GetMultipleCustomWorkitemSummary-request.xml
  • GetMultipleCustomWorkitemSummary-response.xml
Get Predefined Work Item Summary
  • GetPredefinedWorkitemSummary-request.xml
  • GetPredefinedWorkitemSummary-response.xml
Login $MQ_HOME/schema/DataService/2.0/samples/admin
  • Login-Request.xml
  • Login-Response.xml
Logout
  • Logout-Request.xml
  • Logout-Response.xml
Get Entitlement
  • GetEntitlement-request.xml
  • GetEntitlement-response.xml
Create Enterprise
  • CreateEnterprise_Request.xml
  • CreateEnterprise_Response.xml
Get Enterprise
  • GetEnterpriseList-Request.xml
  • GetEnterpriseList-Response.xml
Create User
  • CreateUser_Request.xml
  • CreateUser_Response.xml
  • CreateUser_encryptedPassword-Request.xml
  • CreateUser_encryptedPassowrd-Response.xml
Modify User
  • ModifyUser-AllDetails-Request.xml
  • ModifyUser-AllDetails-Response.xml
Change Password
  • ChangePassword_plaintext-Request.xml
  • ChangePassword_plaintext-Response.xml

  • ChangePassword_encrypted-Request.xml

  • ChangePassword_encrypted-Response.xml

  • ChangePassword_getSecurityQuestions-Request.xml
  • ChangePassword_getSecurityQuestion-Response.xml

  • ChangePassword_SecurityQuestions-Request.xml

  • ChangePassword_SecurityQuestion-Response.xml

User Unlock

  • UserUnlock-Request.xml

  • UserUnlock-Response.xml

Delete User
  • DeleteUser_Request.xml
  • DeleteUser_Response.xml
Get User List
  • GetUserList-request.xml
  • GetUserList-response.xml
Get Role List
  • GetRoleList-request.xml
  • GetRoleList-response.xml
Text Search schemas/home/mdmuser/tibco/mdm/version/schema/DataService/2.0/samples/repository/textSearch/
  • TextSearch-AttributeFuzzyQuery-Request(With Weight).xml
  • TextSearch-AttributeFuzzyQuery-Request(Without Weight).xml
  • TextSearch-AttributeFuzzyQuery-Response(With Weight).xml
  • TextSearch-AttributeFuzzyQuery-Response(Without Weight).xml
  • TextSearch-ExactQuery-Request.xml
  • TextSearch-ExactQuery-Response.xml
  • TextSearch-FuzzyQuery-Request.xml
  • TextSearch-FuzzyQuery-Response.xml
  • TextSearch-IndexEntityFuzzyQuery-Request(With RA).xml

    (RA stands for Relationship Attributes)

  • TextSearch-IndexEntityFuzzyQuery-Request.xml
  • TextSearch-IndexEntityFuzzyQuery-Response(With RA).xml

    (RA stands for Relationship Attributes)

  • TextSearch-IndexEntityFuzzyQuery-Response.xml
Get DataSource schemas/home/mdmuser/tibco/mdm/version/schema/DataService/2.0/samples/datasource
  • GetDataSourceList-request.xml
  • GetDataSourceList-response.xml
Get RepositoryList schemas/home/mdmuser/tibco/mdm/version/schema/DataService/2.0/samples/repository/metadata
  • GetRepositoryList-request.xml
  • GetRepositoryList-response.xml
Initiate Synchronization schemas/home/mdmuser/tibco/mdm/version/schema/DataService/2.0/samples/repository/record-synchronization/
  • Synchronization-Async-Request.xml
  • Synchronization-Async-Response.xml
  • Synchronization-Sync-Request.xml
  • Synchronization-Sync-Response.xml
Upload Metadata schemas/home/mdmuser/tibco/mdm/version/schema/DataService/2.0/samples/repository/metadata
  • UploadMetadata_Request.xml
  • UploadMetadata_Response.xml
Extract Data schemas/home/mdmuser/tibco/mdm/version/schema/DataService/2.0/samples/repository/dataextractor
  • DataExtractor_Request.xml
  • DataExtractor_Response.xml
Get ClassificationSchemeList schemas/home/mdmuser/tibco/mdm/version/schema/DataService/2.0/samples/repository/classification/
  • GetClassificationSchemeListRequest.xml
  • GetClassificationSchemeListResponse.xml
Get ClassificationSchemeAttributeList
  • getClassificationSchemeAttrList_Request.xml
  • getClassificationSchemeAttrList_Response.xml
GetClassificationCodeHierarchy
  • GetClassificationCode_fromRoot_Request.xml
  • GetClassificationCode_fromRoot_Response.xml
  • GetClassificationCode_fromLevel1_Request.xml
  • GetClassificationCode_fromLevel1_Response.xml
  • GetClassificationCode_withmultipleCodes_Request.xml
  • GetClassificationCode_withmultipleCodes_Response.xml
Get DataSource Info schemas/home/mdmuser/tibco/mdm/version/schema/DataService/2.0/samples/datasource 
GetDataSourceInfo-request.xmlGetDataSourceInfo-response.xml
Upload DataSource schemas/home/mdmuser/tibco/mdm/version/schema/DataService/2.0/samples/dataloadservice 
LoadDatasource-Async-Request.xmlLoadDatasource-Async-Response.xmlLoadDatasource-Sync-Request.xmlLoadDatasource-Sync-Response.xmlLoadDatasource-DBloaderSync-Request-fail.xmlLoadDatasource-DBloaderSync-Response-fail.xmlLoadDatasource-NonexistingRepository-Request-fail.xmlLoadDatasource-NonexistingRepository-Response-fail.xml
Import Records 
ImportRecords-Async-Request.xmlImportRecords-Async-Response.xmlImportRecords-Sync-Request.xmlImportRecords-Sync-Response.xml
Load Import Records 
LoadImportRecords-Sync-Request.xmlLoadImportRecords-Sync-Response.xmlLoadImportRecords-Async-Request.xmlLoadImportRecords-Async-Response.xml

Data Transfer 

DataTransfer_Async_Request.xmlDataTransfer_Async_Response.xml
Get Content schemas/home/mdmuser/tibco/mdm/version/schema/DataService/2.0/samples/content
  • ContentService-Download-Request.xml
  • ContentService-Download-Response.xml
Get Event Info schemas/home/mdmuser/tibco/mdm/version/schema/DataService/2.0/samples/eventmgmt
  • Event-GetInfo-Request.xmlEvent-GetInfo-Response.xml
Get Event Details
  • GetEventDetails_Request.xml
  • GetEventDetails_Response.xml
Get Import Event Status
  • GetImportEventStatus_Request.xml
  • GetImportEventStatus_Response.xml