Viewing Group Import Job Reports

This section provides example requests and responses when you want to view a group import summary job report and a group import detailed job report when you import groups into your environment using the Oracle Identity Cloud Service REST API.

Example Import Summary Job Request

To review the group import summary job, send a GET request to the /job/v1/GroupImportSummaryJobReports endpoint using historyId as the identifier.

curl
-X GET
-H "Authorization: Bearer <AccessToken>"
-H "Cache-Control: no-cache"
"https://tenant-base-url/job/v1/GroupImportSummaryJobReports?filter=historyId eq "99a693e0bc89421484f7d4dcb2193725"

Example Import Summary Job Response

{
  "schemas": [
    "urn:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 6,
  "Resources": [{
      "idcsLastModifiedBy": {
        "type": "User",
        "value": "9df357a9767c499ab22b7808da07a722",
        "display": "file_import_export_testUserAdmin file_import_export_testUserAdmin",
        "$ref": "https://tenant-base-url/admin/v1/Users/9df357a9767c499ab22b7808da07a722"
      },
      "idcsCreatedBy": {
        "type": "User",
        "display": "file_import_export_testUserAdmin file_import_export_testUserAdmin",
        "value": "9df357a9767c499ab22b7808da07a722",
        "$ref": "https://tenant-base-url/admin/v1/Users/9df357a9767c499ab22b7808da07a722"
      },
      "type": "info",
      "historyId": "99a693e0bc89421484f7d4dcb2193725",
      "id": "76d122a2e68c436ea195e5d8077c248a",
      "jobType": "GroupImport",
      "meta": {
        "created": "Apr 20, 2017 4:58:56 AM CDT",
        "lastModified": "Apr 20, 2017 4:58:56 AM CDT",
        "resourceType": "GroupImportSummaryJobReport",
        "location": "https://tenant-base-url/job/v1/GroupImportSummaryJobReports/76d122a2e68c436ea195e5d8077c248a"
      },
      "message": "-",
      "urn:ietf:params:scim:schemas:oracle:idcs:extension:groupImportSummary:JobReport": {
        "failRows": 0,
        "description": "This row is checked for re entrant quality",
        "displayName": "RandomGroupgMVlqkMewc",
        "succRows": 1,
        "failMembers": 0,
        "succMembers": 2,
        "totalMembers": 2
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:oracle:idcs:JobReport",
        "urn:ietf:params:scim:schemas:oracle:idcs:extension:groupImportSummary:JobReport"
      ]
    }
  ],
  "startIndex": 1,
  "itemsPerPage": 48
}

Example Import Detailed Job Request

To review the group import detailed job, send a GET request to the /job/v1/GroupImportDetailedJobReports endpoint using historyId as the identifier.

curl
-X GET
-H "Authorization: Bearer <AccessToken>"
-H "Cache-Control: no-cache"
"https://<IDCS-Service-Instance>.identity.oraclecloud.com/job/v1/GroupImportDetailedJobReports?filter=historyId eq "99a693e0bc89421484f7d4dcb2193725"

Example Import Detailed Job Response

{
  "schemas": [
    "urn:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 1,
  "Resources": [{
      "idcsLastModifiedBy": {
        "type": "User",
        "value": "9df357a9767c499ab22b7808da07a722",
        "display": "file_import_export_testUserAdmin file_import_export_testUserAdmin",
        "$ref": "https://tenant-base-url/admin/v1/Users/9df357a9767c499ab22b7808da07a722"
      },
      "idcsCreatedBy": {
        "type": "User",
        "display": "file_import_export_testUserAdmin file_import_export_testUserAdmin",
        "value": "9df357a9767c499ab22b7808da07a722",
        "$ref": "https://tenant-base-url/admin/v1/Users/9df357a9767c499ab22b7808da07a722"
      },
      "type": "info",
      "historyId": "99a693e0bc89421484f7d4dcb2193725",
      "id": "c76c5cc346d2461a89ecb66db9473a1e",
      "jobType": "GroupImport",
      "meta": {
        "created": "Apr 20, 2017 4:58:55 AM CDT",
        "lastModified": "Apr 20, 2017 4:58:55 AM CDT",
        "resourceType": "GroupImportDetailedJobReport",
        "location": "https://tenant-base-url/job/v1/GroupImportDetailedJobReports/c76c5cc346d2461a89ecb66db9473a1e"
      },
      "message": "Group Imported Successfully.",
      "urn:ietf:params:scim:schemas:oracle:idcs:extension:groupImportDetailed:JobReport": {
        "description": "Employee Group5",
        "displayName": "RandomGroupfuJLZurEaY",
        "responseData": "{\"location\":\"https://tenant-base-url/admin/v1/Groups/d44507d5747a46ea9fbf861cfd00549f\",\"method\":\"POST\",\"requestNumber\":\"a7655f03-cc86-4d22-9c7e-e9b398690775\",\"bulkId\":\"a7655f03-cc86-4d22-9c7e-e9b398690775\",\"status\":\"201\"}",
        "requestData": "Display Name=RandomGroupfuJLZurEaY,Description=Employee Group5,User Members=[e-mail];[e-mail]",
        "status": "Creation Succeeded",
        "members": "[e-mail];[e-mail]"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:oracle:idcs:JobReport",
        "urn:ietf:params:scim:schemas:oracle:idcs:extension:groupImportDetailed:JobReport"
      ]
    }
  ],
  "startIndex": 1,
  "itemsPerPage": 48
}