Web Service Samples

The sample request and response XML files of web services are available in each folder specific to the web service: $MQ_HOME/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 $MQ_HOME/schema/DataService/2.0/samples/repository/record-query 
  • MasterCatalogRecord-QueryData-Request.xml
MasterCatalogRecord-QueryData-Response.xml
Record Query Metadata   
  • MasterCatalogRecord-Query-Metadata-Request.xml
MasterCatalogRecord-Query-Metadata-Response.xml
Record Query ValidValues (Init)   
  • MasterCatalogRecord-Query-ValidValues-Request.xml
MasterCatalogRecord-Query-ValidValues-Response.xml
Record Validate    
Record Add or Modify $MQ_HOME/schema/DataService/2.0/samples/repository/record-add_modify_delete 
  • MasterCatalogRecord-Add-Request.xml
MasterCatalogRecord-Add-Response.xml
Record Delete   
  • MasterCatalogRecord-QueryData-Deleted-Request.xml
MasterCatalogRecord-QueryData-Deleted-Response.xml
Initiate Workflow $MQ_HOME/schema/DataService/2.0/samples/repository/record-add_modify_delete 
  • MasterCatalogRecord-InitiateWorkflow-Request.xml
MasterCatalogRecord-InitiateWorkflow-Response.xml
Process Records $MQ_HOME/schema/DataService/2.0/samples/processrecords 
  • processRecords_success_allinputs-request.xml
processRecords_success-response.xml
processRecords_undefined_datasource-request.xml
processRecords-undefined_datasource-response.xml
processRecords_undefined_inputmap-request.xml
processRecords_undefined_inputmap-response.xml
processRecords_no_permission-response.xml
Work Item Query Parameters $MQ_HOME/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 $MQ_HOME/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_Request.xml
  • ModifyUser_Response.xml
Change Password
  • ChangePassword_Request.xml
  • ChangePassword_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 Serach $MQ_HOME/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 $MQ_HOME/schema/DataService/2.0/samples/datasource
  • GetDataSourceList-request.xml
  • GetDataSourceList-response.xml
Get RepositoryList $MQ_HOME/schema/DataService/2.0/samples/repository/metadata
  • GetRepositoryList-request.xml
  • GetRepositoryList-response.xml
Initiate Synchronization $MQ_HOME/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 $MQ_HOME/schema/DataService/2.0/samples/repository/metadata
  • UploadMetadata_Request.xml
  • UploadMetadata_Response.xml
Extract Data $MQ_HOME/schema/DataService/2.0/samples/repository/dataextractor
  • DataExtractor_Request.xml
  • DataExtractor_Response.xml
Get ClassificationSchemeList $MQ_HOME/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 $MQ_HOME/schema/DataService/2.0/samples/datasource 
GetDataSourceInfo-request.xml

GetDataSourceInfo-response.xml

Upload DataSource $MQ_HOME/schema/DataService/2.0/samples/dataloadservice 
  • LoadDatasource-Async-Request.xml
LoadDatasource-Async-Response.xml
LoadDatasource-Sync-Request.xml
LoadDatasource-Sync-Response.xml
LoadDatasource-DBloaderSync-Request-fail.xml
LoadDatasource-DBloaderSync-Response-fail.xml
LoadDatasource-NonexistingRepository-Request-fail.xml
LoadDatasource-NonexistingRepository-Response-fail.xml
Import Records 
  • ImportRecords-Async-Request.xml
ImportRecords-Async-Response.xml
ImportRecords-Sync-Request.xml
ImportRecords-Sync-Response.xml
Load Import Records 
  • LoadImportRecords-Sync-Request.xml
LoadImportRecords-Sync-Response.xml
LoadImportRecords-Async-Request.xml
LoadImportRecords-Async-Response.xml
  • Data Transfer 
    DataTransfer_Async_Request.xml
DataTransfer_Async_Response.xml
Get Content $MQ_HOME/schema/DataService/2.0/samples/content
  • ContentService-Download-Request.xml 
  • ContentService-Download-Response.xml
Get Event Info $MQ_HOME/schema/DataService/2.0/samples/eventmgmt 
  • Event-GetInfo-Request.xml
Event-GetInfo-Response.xml
Get Event Details
  • GetEventDetails_Request.xml
  • GetEventDetails_Response.xml
Get Import Event Status
  • GetImportEventStatus_Request.xml
  • GetImportEventStatus_Response.xml