createDataSource

  • Web Services
  • UMPI
  • API Documentation

If you have large volumes of data sources and frequent additions to your list of data sources, you can use the createDataSource web service creates a new, valid data source in the UMPI.

  • Newly added data source may takes about 10-15 minutes become available/appear.
  • This service only adds data sources. It does not delete or modify data sources.
  • You can add one or multiple data source codes to your configured list with a single web service call, up to a limit of 10 data sources per web service call.
Important
Verato only recommends the use of this web service for select customers. You can also contact Verato customer support and ask them to add or remove data sources.

Each Verato UMPI user account is assigned permissions to create, read, update and delete data from a defined list of data sources.

Failed data source additions 

Data sources that are added or fail to be added are noted in the web service response.  Failed additions will not prevent other data sources from being added successfully. Failures are typically caused by one of the following:

  • The data source might already exist on your list
  • The data source might be a special reserved source code, (for example, "Verato"), and it cannot be added to a client-specific data source list.

createDataSource JSON request

  • The request includes:

    • A tracking ID (an optional identifier that the client can supply to track the response)
    • The list of data source codes you wish to add The response includes:
    • An ‘echo’ of the same tracking ID from the request
    • Several Boolean and string values with more information about the success/failure of the service (see section 1 of the main Universal MPI documentation for more information)
    • A response list of all data source codes from your request along with the success/failure status of each data source code
  • {
      "content": { 
        "sources": 
          [ "string" 
        ] 
      }, 
      "trackingId": "string"
    }
    

createDataSource JSON response

  • The response includes:

    • An ‘echo’ of the same tracking ID from the request
    • Several Boolean and string values with more information about the success/failure of the service (see section 1 of the main Universal MPI documentation for more information)
    • A response list of all data source codes from your request along with the success/failure status of each data source code
  • {
      "success": true, 
      "retryableError":  true, 
      "message": "string", 
      "content": {
        "datasourceCreationResponses": [
          { 
            "datasource": "string",
            "status": "string"
          } 
        ] 
          }, 
             "errors": [
               "string" ], 
             "trackingId": "string", 
             "auditId": UUID
          
    }