Job log admin resources
| Operation | Description |
|---|---|
| GET /api/admin/jobs/logs | Get a list of job log files |
| GET /api/admin/jobs/logs/{filename} | Get a job log file |
GET /api/admin/jobs/logs
This will return a list of the job logs and their details.
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| page | Number of the page, starting at zero |
query | integer (int32) | |
| size | Number of elements per page |
query | integer (int32) |
Responses
- 200 OK
-
The job log files
- Content-Type application/vnd.com.fico.xpress.insight.v2+json
-
Properties
- content: object[]
-
Array of JobLogFile
- 403 Forbidden
-
The user did not have authority to get the job logs
GET /api/admin/jobs/logs/{filename}
Get the job log file contents.
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| filename | The job log filename |
path | string | required |
Responses
- 200 OK
-
The job log file contents
- Content-Type application/vnd.com.fico.xpress.insight.v2+octet-stream
-
string (binary)
- 403 Forbidden
-
The user did not have authority to view the job log file
- 404 Not Found
-
The log file was not found
- Content-Type application/vnd.com.fico.xpress.insight.v2+json
- Content-Type application/vnd.com.fico.xpress.insight.v2+octet-stream
-
Empty response body
Example: {
"error": {
"code": "FICO-Platform-Http-404",
"desc": "Not Found",
"innerError": {
"code": "OPTI-Insight-Persistence-DocumentNotFound",
"desc": "Document not found",
"message": "Unable to find document"
},
"message": "Not Found",
"parentId": "0000000000000def",
"spanId": "0000000000000123",
"timestamp": "1970-01-03T02:01:33.219Z",
"traceId": "0000000000000abc"
}
}
An error detail
Properties
- code: string
-
The unique code for this error
Example: "FICO_PLATFORM_VALIDATION_INVALID_VALUE" - desc: string
-
A description of this error for client information, not intended for display to the end user
Example: "Conflict" - message: string
-
A message providing further information which may be displayed to the end user
Example: "Conflict" - target: string
-
An identifier to help the client locate the error. Typically a JSON property name.
- timestamp: string (date-time)
-
When the error was first detected
An error response containing fault or error information
Properties
- error:
-
The top level error
More specific error information
Properties
- code: string
-
The unique code for this error
Example: "FICO-Platform-Validation-FileTooLarge" - desc: string
-
A description of this error for client information, not intended for display to the end user
Example: "Attachment upload too large" - innerError:
-
More specific error information
- message: string
-
A message providing further information which may be displayed to the end user
Example: "Files larger than 300 MB cannot be uploaded as attachments."
Job log file details
Properties
- filename: string
-
The file name of the job log
Example: "insight-job-log.json" - lastModified: string (date-time)
-
The last modified timestamp of the job log file
- size: integer (int64)
-
Size of the job log file in bytes
- url: string
-
The URL of this file
Example: "/api/admin/jobs/logs/job-log.json"
The top level error
Properties
- code: string , one of { FICO-Platform-Http-400 , FICO-Platform-Http-404 , FICO-Platform-Http-406 , FICO-Platform-Http-409 , FICO-Platform-Http-413 , FICO-Platform-Http-422 , FICO-Platform-Http-423 , FICO-Platform-Http-429 , FICO-Platform-Http-500 , FICO-Platform-Http-502 , FICO-Platform-Http-503 }
-
The unique code for this error
Example: "FICO-Platform-Http-409" - desc: string
-
A description of this error for client information, not intended for display to the end user
Example: "Conflict" - details: object[]
-
Details about specific errors that led to this reported error
Array of ErrorDetail - innerError:
-
More specific error information
- message: string
-
A message providing further information which may be displayed to the end user
Example: "Conflict" - parentId: string
-
An OpenTracing parent-span ID
Example: "0020000000000001" - spanId: string
-
An OpenTracing span ID
Example: "b2fb4a1d1a96d312" - timestamp: string (date-time)
-
When the error was first detected
- traceId: string
-
An OpenTracing trace ID
Example: "463ac35c9f6413ad48485a3953bb6125"
A page containing a subset of content which can be paginated through
Properties
- content: object[]
-
The items in this page of results
Array of object - first: boolean
-
Whether this is the first page
Example: false - last: boolean
-
Whether this is the last page
Example: true - number: integer (int32)
-
The page number, starting at 0
Example: 4 - numberOfElements: integer (int32)
-
The number of elements in this page of results
Example: 18 - size: integer (int32)
-
The number of results per page
Example: 20 - sort:
-
The sort order applied to the results
- totalElements: integer (int32)
-
The total number of elements in all the pages
Example: 98 - totalPages: integer (int32)
-
The total number of pages
Example: 5
© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.