다음 options들은 모든 REST API에 적용할 수 있다.

Pretty Results

Request의 말미에 ?pretty=true를 추가했을 때는 JSON이 예쁜 형태로 리턴된다. (단지 디버깅 목적으로만 사용하라!) 또다른 옵션으로 ?format=yaml로 설정하면 더 읽기 쉬운 yaml 형태로 결과가 리턴될 것이다.

Human Readable Output

통계는 사람에게 적합한 형태 (예를 들어 "exist_time":"1h" or "size":"1kb")와 컴퓨터에게 적합한 형태 (예를 들어 "exists_time_in_millis": 3600000 or "size_in_bytes": 1024)로 리턴된다. 사람이 읽기에 적합한 형태의 값들은 query string에 ?human=false를 추가하여 기능을 끌 수 있다. 이것은 통계 결과가 사람보다는 모니터링 툴에 의해 다루어질 때 의미가 있다. 기본적으로 human flag는 false이다.

Flat Settings

Flat_settings flag는 설정값들을 제시하는 효과가 있다. Flag_settigns값이 true일 때, 설정값들이 flat format 형태로 리턴된다.

{
  "persistent" : { },
  "transient" : {
   "discovery.zen.minimum_master_nodes" : "1"
  }
}

Flat_settings가 false일 때, 설정값들은 좀 더 사람이 읽을 수 있는 구조화된 형태로 리턴된다.

{
  "persistent" : { },
  "transient" : {
   "discovery" : {
     "zen" : {
       "minimum_master_nodes" : "1"
     }
   }
  }
}

기본적으로 flat_settings 값은 false이다.

Parameters

REST parameter들(HTTP를 사용할 때, HTTP URL에 사용되는 parameter들)은 underscore를 사용한다. (underline 사용)

Boolean Values

모든 REST API parameter들은 (request parameter와 JSON body) boolean "false"에 해당하는 값으로 false, 0, no, off를 사용할 수 있다. 그 이외 다른 값들은 모두 "true"로 간주한다. Index된 document내에서 boolean field를 다루는 것과는 아무 상관이 없다는 것에 유의하라. (단지 request parameter와 json body에서만 이렇게 다룬다는 뜻임.)

Number Values

모든 REST API는 JSON number type 뿐만 아니라 string으로 number 값을 표시하는 것을 지원한다.

Time Units

Duration이 필요할 경우, 예를 들어 timeout parameter이 경우에 duration은 밀리초를 나타내는 숫자로 표시할 수 있다. 혹은 2일의 경우 2d와 같이 표시할 수도 있다. 지원되는 단위는 다음과 같다.

y : Year

M : Month

w : Week

d : Day

h : Hour

m : Minute

s : Second