Initializing help system before first use

ProfileEndpoints

Endpoints relating to administrator configuration settings

GET /profile/bucket-names

Get the list of available timing buckets for the given type

Request Parameters
name type description constraints
type query "DAY" or "HOUR" or "MINUTE" or "MONTH"
Response Body
media type data type description
application/json;charset=UTF-8 (custom)

Example

Request
GET /profile/bucket-names
Content-Type: */*
Accept: application/json;charset=UTF-8

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

                
...
                
              

POST /profile/buckets

Query for buckets

Request Body
media type data type
application/json;charset=UTF-8 (custom)
Response Body
media type data type description
application/json;charset=UTF-8 (custom)

Example

Request
POST /profile/buckets
Content-Type: application/json;charset=UTF-8
Accept: application/json;charset=UTF-8

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8

                
...
                
              

GET /profile/logged-bucket-names

Return the time buckets for profiling

Response Body
media type data type description
application/json;charset=UTF-8 (custom)

Example

Request
GET /profile/logged-bucket-names
Content-Type: */*
Accept: application/json;charset=UTF-8

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

                
...
                
              

PUT /profile/logged-bucket-names

Set the time buckets for which to write profiles in the log

Request Body
media type data type
application/json array of OperationsProfileBucketType (JSON)
Response Body
media type data type description
application/json;charset=UTF-8 (custom)

Example

Request
PUT /profile/logged-bucket-names
Content-Type: application/json
Accept: application/json;charset=UTF-8

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json;charset=UTF-8

                
...
                
              

GET /profile/operation-names

Get the list of operation names for which we have profiling data

Response Body
media type data type description
application/json;charset=UTF-8 (custom)

Example

Request
GET /profile/operation-names
Content-Type: */*
Accept: application/json;charset=UTF-8

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

                
...
                
              

GET /profile/store

Return whether we're storing profile data

Response Body
media type data type description
application/json;charset=UTF-8 (custom)

Example

Request
GET /profile/store
Content-Type: */*
Accept: application/json;charset=UTF-8

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

                
...
                
              

PUT /profile/store

Set the time buckets for which to write profiles in the log

Request Body
media type data type
application/json boolean (JSON)
Response Body
media type data type description
application/json;charset=UTF-8 (custom)

Example

Request
PUT /profile/store
Content-Type: application/json
Accept: application/json;charset=UTF-8

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json;charset=UTF-8

                
...
                
              

© 2001-2020 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.