Rel doc - Rel

POST

Tokenize a long query parameter value.
The process:
1) discover a query parameter is too long to put in a URI, such as GET /orders/digests?rql=REALLY_LONG_RQL_HERE
2) POST "REALLY_LONG_RQL_HERE" to /properties/qpvalues
3) get back a token, such as [543]
4) do the GET of #1 as GET /orders/digests?rql=[543]
The token has a short life, so don't expect to use it tomorrow, or even later today.
Success status: 201

none

the value of a uri query parameter

	Type	Description
Token	string	For POST leave this null; in a response body, token will be an integer value in brackets, e.g., [6782634]. If this were the token for the rql parameter, the uri should then be http://example.org/orders?rql=[6782634].
Value	string	for example, if the uri were http://example.org/orders?rql=readonly.orderid=in=(1234,2345,346,457,45678,76890) , value would be readonly.orderid=in=(1234,2345,346,457,45678,76890)

Sample content-type: application/hal+json

{
  "token": "str",
  "value": "str"
}

the value of a uri query parameter

	Type	Description
Token	string	For POST leave this null; in a response body, token will be an integer value in brackets, e.g., [6782634]. If this were the token for the rql parameter, the uri should then be http://example.org/orders?rql=[6782634].
Value	string	for example, if the uri were http://example.org/orders?rql=readonly.orderid=in=(1234,2345,346,457,45678,76890) , value would be readonly.orderid=in=(1234,2345,346,457,45678,76890)

Sample accept: application/hal+json

{
  "token": "str",
  "value": "str"
}

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.