Jump to

• Request
• Response
• Examples

Get Migration Job by jobId

get

/process/api/v1/oic-migration/jobs/{jobId}

Get all the details of a bulk migration job by jobId.

Request

Path Parameters

• jobId(required): string
  Bulk migration job id

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : MigrationJob

Type: object

Show Source

• bucketUrl: string
• finishedDate: string (date-time)
• id: string (uuid)
• jobApps: array jobApps
• startedDate: string (date-time)
• status: string
  Allowed Values: [ "NOT_STARTED", "IN_PROGRESS", "SUCCESSFUL", "FAILED" ]

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "bucketUrl":{
            "type":"string"
        },
        "jobApps":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MigrationJobApp"
            }
        },
        "startedDate":{
            "type":"string",
            "format":"date-time"
        },
        "finishedDate":{
            "type":"string",
            "format":"date-time"
        },
        "status":{
            "type":"string",
            "enum":[
                "NOT_STARTED",
                "IN_PROGRESS",
                "SUCCESSFUL",
                "FAILED"
            ]
        }
    }
}

Nested Schema : jobApps

Type: array

Show Source

• Array of: object MigrationJobApp

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MigrationJobApp"
    }
}

Nested Schema : MigrationJobApp

Type: object

Show Source

• appUrl: string
• id: string (uuid)
• migrationId: string (uuid)
• name: string
• status: string
  Allowed Values: [ "NOT_STARTED", "IN_PROGRESS", "SUCCESSFUL", "FAILED" ]
• version: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "appUrl":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "enum":[
                "NOT_STARTED",
                "IN_PROGRESS",
                "SUCCESSFUL",
                "FAILED"
            ]
        },
        "migrationId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

404 Response

Migration job not found.

500 Response

An internal error occurred.

Back to Top

Examples

The following example shows how to retrieve details of a migration job by submitting a GET request on the REST resource using cURL. For more information about cURL, see cURL Access. For more information about endpoint URL structure, see Send Requests.

Example: Get details of migration job 3fa85f64-5717-4562-b3fc-2c963f66afa6

curl -X 'GET' \ 'https://<OIC URL>/process/api/v1/oic-migration/jobs/3fa85f64-5717-4562-b3fc-2c963f66afa6' \ -H
      'accept: application/json'

Example: Response body of 200 successful operation in JSON format

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "bucketUrl": "string",
  "jobApps": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "appUrl": "string",
      "name": "string",
      "version": "string",
      "status": "NOT_STARTED",
      "migrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "startedDate": "2024-08-09T10:21:32.873Z",
  "finishedDate": "2024-08-09T10:21:32.873Z",
  "status": "NOT_STARTED"
}

Back to Top