Jump to

• Request
• Response
• Examples

Get Auto-Generate Configuration Models Task Logs

get

/rest/v19/bomItemSetups/actions/getLogs/{taskId}

Use this endpoint to retrieve detailed processing logs related to model configuration generation. It returns status details of BOM processing, including success, failure, and skipped counts. It also includes processing metrics like total processing time and per-record performance.

Request

Path Parameters

• taskId(required): integer(int32)
  Id of the task created by the generateConfigurations API

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful response containing logs for the specified taskId.

Body ()

Root Schema : schema

Type: object

Response model for Get Logs API

Show Source

• details: array details
• metrics: object metrics
• overallBatchStatus: string
• summary: object summary
• taskId: integer(int32)

{
    "type":"object",
    "properties":{
        "taskId":{
            "type":"integer",
            "format":"int32"
        },
        "overallBatchStatus":{
            "type":"string"
        },
        "summary":{
            "type":"object",
            "properties":{
                "totalNumberOfBomsFailed":{
                    "type":"integer",
                    "format":"int32"
                },
                "totalNumberOfBomsProcessed":{
                    "type":"integer",
                    "format":"int32"
                },
                "totalNumberOfBomsRead":{
                    "type":"integer",
                    "format":"int32"
                },
                "totalNumberOfBomsSkipped":{
                    "type":"integer",
                    "format":"int32"
                }
            }
        },
        "metrics":{
            "type":"object",
            "properties":{
                "averageProcessingTimePer1000Records":{
                    "type":"string"
                },
                "totalTimeTaken":{
                    "type":"string"
                }
            }
        },
        "details":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "rootBomVarName":{
                        "type":"string"
                    },
                    "status":{
                        "type":"string"
                    }
                }
            }
        }
    },
    "description":"Response model for Get Logs API"
}

Nested Schema : details

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "rootBomVarName":{
                "type":"string"
            },
            "status":{
                "type":"string"
            }
        }
    }
}

Nested Schema : metrics

Type: object

Show Source

• averageProcessingTimePer1000Records: string
• totalTimeTaken: string

{
    "type":"object",
    "properties":{
        "averageProcessingTimePer1000Records":{
            "type":"string"
        },
        "totalTimeTaken":{
            "type":"string"
        }
    }
}

Nested Schema : summary

Type: object

Show Source

• totalNumberOfBomsFailed: integer(int32)
• totalNumberOfBomsProcessed: integer(int32)
• totalNumberOfBomsRead: integer(int32)
• totalNumberOfBomsSkipped: integer(int32)

{
    "type":"object",
    "properties":{
        "totalNumberOfBomsFailed":{
            "type":"integer",
            "format":"int32"
        },
        "totalNumberOfBomsProcessed":{
            "type":"integer",
            "format":"int32"
        },
        "totalNumberOfBomsRead":{
            "type":"integer",
            "format":"int32"
        },
        "totalNumberOfBomsSkipped":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• rootBomVarName: string
• status: string

{
    "type":"object",
    "properties":{
        "rootBomVarName":{
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve detailed processing logs related to model configuration generation by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET -H "Authorization: Bearer <token>" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/bomItemSetups/actions/getLogs/12345

Response Body Sample

{
  "taskId": 12345,
  "overallBatchStatus": "Completed",
  "summary": {
    "totalNumberOfBomsFailed": 2,
    "totalNumberOfBomsProcessed": 18,
    "totalNumberOfBomsRead": 20,
    "totalNumberOfBomsSkipped": 0
  },
  "metrics": {
    "averageProcessingTimePer1000Records": "5.2s",
    "totalTimeTaken": "2m30s"
  },
  "details": [{
      "rootBomVarName": "BOM_001",
      "status": "Processed"
    }, {
      "rootBomVarName": "BOM_002",
      "status": "Failed"
    }
  ]
}

Back to Top