Skip to content

Events

Message contracts v1.0

TransferStarted

  • Description: Indicates that a transfer processing has started.
  • Sample:

    {
      "specversion": "1.0",
      "customerid": "f0b919d1-80c2-49e4-9e27-31e4e9b9fdfa",
      "projectid": "98da827b-407c-418d-8064-6c27b5417bfb", 
      "userid": "6131709d-3181-4372-8bef-e33498e09333", 
      "resourceid": "42bd92cf-6c58-47c1-be35-1b01f60b6580",
      "type": "dhi.waterdata.events.transferstartedevent",
      "source": "/dhi/platform/transfer",
      "id": "29a52c94-b8aa-436e-aa47-4fd5610f998c",
      "time": "2021-04-26T08:39:02.5923813Z",
      "subject": "Transfer started",
      "dataschema": "https://schemas.mike-cloud.com/platform/transfer/v1/transferstartedevent", 
      "datacontenttype": "application/json",
      "data": {
        "TransferId": "42bd92cf-6c58-47c1-be35-1b01f60b6580",
        "CustomerGuid": "f0b919d1-80c2-49e4-9e27-31e4e9b9fdfa",
        "ProjectId": "98da827b-407c-418d-8064-6c27b5417bfb",
        "UserId": "6131709d-3181-4372-8bef-e33498e09333"
      },
      "offset": "17182746240"
    }
    

    Note:
    ResourceId represents the ID of the started transfer.

TransferProgress

  • Description: Provides information about the current status/progress of a transfer.
  • Sample:

    {
      "specversion": "1.0",
      "customerid": "f0b919d1-80c2-49e4-9e27-31e4e9b9fdfa",
      "projectid": "98da827b-407c-418d-8064-6c27b5417bfb", 
      "userid": "6131709d-3181-4372-8bef-e33498e09333", 
      "resourceid": "42bd92cf-6c58-47c1-be35-1b01f60b6580",
      "type": "dhi.waterdata.events.transferprogressevent",
      "source": "/dhi/platform/transfer",
      "id": "4d50011f-65df-4e3e-a7de-d4c6d401c64b",
      "time": "2021-04-26T08:39:02.5923813Z",
      "subject": "Transfer progress",
      "dataschema": "https://schemas.mike-cloud.com/platform/transfer/v1/transferprogressevent",
      "datacontenttype": "application/json", 
      "data": {
        "TransferId": "42bd92cf-6c58-47c1-be35-1b01f60b6580",
        "Message": "Transfer routing finished successfully",
        "CustomerGuid": "f0b919d1-80c2-49e4-9e27-31e4e9b9fdfa",
        "ProjectId": "98da827b-407c-418d-8064-6c27b5417bfb",
        "UserId": "6131709d-3181-4372-8bef-e33498e09333"
      },
      "offset": "17182746241"
    }
    

    Note:
    ResourceId represents the ID of the transfer for which the current status/progress is reported.

TransferFinished

  • Description: Indicates that transfer processing has finished.
  • Sample:

    {
      "specversion": "1.0",
      "customerid": "f0b919d1-80c2-49e4-9e27-31e4e9b9fdfa",
      "projectid": "98da827b-407c-418d-8064-6c27b5417bfb", 
      "userid": "6131709d-3181-4372-8bef-e33498e09333", 
      "resourceid": "42bd92cf-6c58-47c1-be35-1b01f60b6580",
      "type": "dhi.waterdata.events.transferfinishedevent",
      "source": "/dhi/platform/transfer",
      "id": "3bd2d26e-515c-47a8-8887-adceb9c8f07d",
      "time": "2021-04-26T08:39:02.5923813Z",
      "subject": "Transfer finished",
      "dataschema": "https://schemas.mike-cloud.com/platform/transfer/v1/transferfinishedevent", 
      "datacontenttype": "application/json", 
      "data": {
        "TransferId": "42bd92cf-6c58-47c1-be35-1b01f60b6580",
        "ErrorMessage": null,
        "OutputFileAbsoluteUri": "https://coremetadatadev0stor.blob.core.windows.net:443/importexport/a968b653-b733-4d5b-9422-66ec5075b7ee?sv=2020-04-08&spr=https,http&se=2021-05-19T04%3A07%3A59Z&sr=b&sp=r&sig=U9NKvJmRzon3vEwoziOg%2FIto8EoW9QNd%2FPaYt826fG%4F",
        "TransferResultType": "Import",
        "ResultSizeKB" : 1,
        "AffectedDatasetIds": ["7ab4ffbf-e808-4ab2-b48d-4336f60cb035"],
        "CustomerGuid": "f0b919d1-80c2-49e4-9e27-31e4e9b9fdfa",
        "ProjectId": "98da827b-407c-418d-8064-6c27b5417bfb",
        "UserId": "6131709d-3181-4372-8bef-e33498e09333"
      },
      "offset": "17182746242"
    }
    

    Note:
    ResourceId represents the ID of the finished transfer.