Mirror admin resources
| Operation | Description |
|---|---|
| GET /api/admin/mirror | Get the mirror configuration |
| PATCH /api/admin/mirror | Update the mirror configuration |
GET /api/admin/mirror
Responses
- 200 OK
-
The mirror configuration
- Content-Type application/vnd.com.fico.xpress.insight.v2+json
- 404 Not Found
-
There is no mirror configured for this server
- Content-Type application/vnd.com.fico.xpress.insight.v2+json
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"
}
}
PATCH /api/admin/mirror
Request Body
- Content-Type application/json
Responses
- 200 OK
-
The mirror configuration was updated
- Content-Type application/vnd.com.fico.xpress.insight.v2+json
- 404 Not Found
-
There is no mirror configured for this server
- Content-Type application/vnd.com.fico.xpress.insight.v2+json
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"
}
} - 422 Unprocessable Entity
-
Validation of the requested changes failed.
- Content-Type application/vnd.com.fico.xpress.insight.v2+json
Example: {
"error": {
"code": "FICO-Platform-Http-422",
"desc": "Unprocessable Entity",
"innerError": {
"code": "FICO-Platform-Validation-InvalidValue",
"desc": "Entity processing failed",
"message": "Entity processing failed"
},
"message": "Unprocessable Entity",
"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."
Provides for configuring mirror behaviour.
Properties
- maxIdleTime: integer (int32) , { x ∈ ℤ | 0 ≤ x ≤ 31536000 }
-
The configured maximum time, in seconds, the data for a scenario will live before it is evicted
Example: 1209600 - minTimeToLive: integer (int32) , { x ∈ ℤ | 0 ≤ x ≤ 31536000 }
-
The configured minimum time, in seconds, the data for a scenario will live before being eligible for eviction
Example: 604800 - targetCapacity: integer (int32) , { x ∈ ℤ | 0 ≤ x ≤ 1000 }
-
The mirror capacity the system will attempt to maintain
Example: 1000
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"
© 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.