ThrottleService Resource

Handle throttle information

DELETE /throttle

Delete entries from the throttle lists. param context Context of the user, ie DasCtx, IndexingCtx ... (required if session is used) param querySession User session identifier obtained from CIS param querySessionId - session id param accessToken - access token. param headerSession - session found in the header. param cookieSession Same as session and won't be used if session is provided. (optional)

Request Parameters
name type description default constraints
global query false boolean
Request Body
media type data type
application/json ThrottleData (JSON)

Example

Request
DELETE /throttle
Content-Type: application/json

                
{
  "interval" : 12345,
  "limit" : 12345,
  "whiteList" : [ {
    "source" : "...",
    "pattern" : "..."
  }, {
    "source" : "...",
    "pattern" : "..."
  } ],
  "blackList" : [ {
    "source" : "...",
    "pattern" : "..."
  }, {
    "source" : "...",
    "pattern" : "..."
  } ],
  "mode" : 12345
}
                
              
Response
HTTP/1.1 204 No Content

              

GET /throttle

Get throttle settings for das. param context Context of the user, ie DasCtx, IndexingCtx ... (required if session is used) param querySession User session identifier obtained from CIS param querySessionId - session id param accessToken - access token. param headerSession - session found in the header. param cookieSession Same as session and won't be used if session is provided. (optional)

Response Body
media type data type description
application/json ThrottleData (JSON) ThrottleData

Example

Request
GET /throttle
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "interval" : 12345,
  "limit" : 12345,
  "whiteList" : [ {
    "source" : "...",
    "pattern" : "..."
  }, {
    "source" : "...",
    "pattern" : "..."
  } ],
  "blackList" : [ {
    "source" : "...",
    "pattern" : "..."
  }, {
    "source" : "...",
    "pattern" : "..."
  } ],
  "mode" : 12345
}
                
              

POST /throttle

Update throttle settings for das.

Request Parameters
name type description default constraints
global query - flag indicating whether all finders should be updated. false boolean
interval query - sets the tracking interval (value is in minutes)   int
limit query - sets the download limit for throttling   int
mode query   int
Request Body
media type data type
application/json ThrottleData (JSON)

Example

Request
POST /throttle
Content-Type: application/json

                
{
  "interval" : 12345,
  "limit" : 12345,
  "whiteList" : [ {
    "source" : "...",
    "pattern" : "..."
  }, {
    "source" : "...",
    "pattern" : "..."
  } ],
  "blackList" : [ {
    "source" : "...",
    "pattern" : "..."
  }, {
    "source" : "...",
    "pattern" : "..."
  } ],
  "mode" : 12345
}
                
              
Response
HTTP/1.1 201 Created