Path parameters

• jobId string Required

  Job ID

  Format should match the following pattern: ^[A-Za-z0-9\-]+$.

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • id string Required

    Format should match the following pattern: ^[A-Za-z0-9\-]+$.

  • projectId string Required

    Format should match the following pattern: ^[A-Za-z0-9\-]+$.

  • status string Required

    Values are RUNNING, FAILED, CANCELLING, CANCELLED, COMPLETED, or CLEANING_UP.

  • cdcStatus string

    Values are NOT_STARTED, RUNNING, COMPLETING, COMPLETED, FAILED, CANCELLED, or PAUSED. Default value is NOT_STARTED.

  • verificationJobId string
  • options object Required

    Additional properties are NOT allowed.

    Hide options attributes Show options attributes object

    • dropCollections boolean

      Default value is false.

    • mode string Required

      Values are SNAPSHOT, CDC, or CDC_ONLY.

    • errorHandling string

      Values are FAIL, WARN, or SKIP. Default value is FAIL.

    • errorTolerance integer

      The number of failures (on the record level) that should be tolerated before terminating the migration. The value is strictly greater than or equal to.

      Minimum value is 0.

  • jdbcConnectionString string
  • mongoDbConnectionString string
  • atlasMetadata object
    Hide atlasMetadata attributes Show atlasMetadata attributes object

    • mongoDbProjectName string
    • mongoDbProjectId string
    • mongoDbClusterName string
  • submittedAt string(date-time) Required
  • statistics object

    Additional properties are NOT allowed.

    Hide statistics attributes Show statistics attributes object

    • startedAt string(date-time)
    • elapsedSeconds integer(int64)
    • remainingTableCount integer
    • processingTables array[string]
    • totalEventsSeen integer(int64)

      Default value is 0.

    • snapshotCompleted boolean

      Default value is false.

    • totalTableCount integer
    • totalEvents integer(int64)
    • totalEventSize integer(int64)
  • cdcStatistics object

    Additional properties are NOT allowed.

    Hide cdcStatistics attributes Show cdcStatistics attributes object

    • startedAt string(date-time)
    • lastEventTime string(date-time)
    • eventsInLastHour integer(int64)

      Default value is 0.

    • eventsInLastMinute integer(int64)

      Default value is 0.

    • totalEventsSeen integer(int64)

      Default value is 0.

  • jobUpdates array[object]
    Hide jobUpdates attributes Show jobUpdates attributes object

    • eventType string Required

      Values are ERROR, WARNING, or INFO.

    • stage string

      Values are SNAPSHOTTING, STREAMING, or VERIFICATION.

    • message string Required
    • details string
    • timestamp string(date-time) Required
    • stackTrace string
    • errorCode string
    • suggestion string
    • locationType string

      Values are TABLE or COLLECTION.

    • locationName string
    • fieldName string
    • key object
      Hide key attribute Show key attribute object

      • * string Additional properties
    • count integer(int64)

    • location object

      One of:

      tableLocation object collectionLocation object documentLocation object

      Hide attribute Show attribute

      • table string Required

      Hide attribute Show attribute

      • collection string Required

      Hide attributes Show attributes

      • collection string Required
      • document string Required
  • failureError object

    Additional properties are NOT allowed.

    Hide failureError attributes Show failureError attributes object

    • errorType string Required
    • message string Required
    • failureAt string(date-time) Required
    • setupError boolean Required

      Default value is false.

  • metadata object

    Additional properties are NOT allowed.

    Hide metadata attributes Show metadata attributes object

    • telemetryUserId string
    • verificationRequested boolean

      Default value is false.

    • verificationStatus string

      Values are VERIFYING, FAILED, CANCELLING, CANCELLED, VERIFIED, or ABORTED.

  • relationalTableFilters object

    An object where each key represents a schema name. Each schema contains tables that you can apply table filters on.

    Hide relationalTableFilters attribute Show relationalTableFilters attribute object

    • * object Additional properties

      An object where each key represents a table name within a schema.

      Hide * attribute Show * attribute object

      • * object Additional properties

        Additional properties are NOT allowed.

        Hide * attributes Show * attributes object

        • whereClause string

          Contents of the SQL WHERE clause to filter rows for the specified source table.

        • rowCount integer(int64)

          Optional limit to the number of rows returned from the source table.

• 400 application/json

  Bad request

  Hide response attributes Show response attributes object

  • jobId string

    Format should match the following pattern: ^[A-Za-z0-9\-]+$.

  • message string Required
  • description string
  • timestamp string(date-time) Required
• 404 application/json

  Not found

  Hide response attributes Show response attributes object

  • jobId string

    Format should match the following pattern: ^[A-Za-z0-9\-]+$.

  • message string Required
  • description string
  • timestamp string(date-time) Required