{"id":5460,"date":"2023-05-01T11:52:14","date_gmt":"2023-05-01T11:52:14","guid":{"rendered":"https:\/\/info.documotor.com\/?page_id=5460"},"modified":"2023-05-01T12:04:13","modified_gmt":"2023-05-01T12:04:13","slug":"list-of-built-in-functions","status":"publish","type":"page","link":"https:\/\/info.documotor.com\/?page_id=5460","title":{"rendered":"List of Built-in Functions"},"content":{"rendered":"\n

While there are some extensions made to the JMESPath query language in DocuMotor, a lot of functionality is documented at jmespath.org<\/a>. <\/p>\n\n\n\n

You can find information on each specific function by following the links below.<\/p>\n\n\n\n

JMESPath<\/strong><\/td>Reference<\/strong><\/td>Output<\/strong><\/td><\/tr>
abs<\/a><\/td>number abs(number $value)<\/code><\/td>Returns the absolute value of the provided argument.<\/td><\/tr>
avg<\/a><\/td>number avg(array[number] $elements)<\/code><\/td>Returns the average of the elements in the provided array.<\/td><\/tr>
contains<\/a><\/td>boolean contains(array|string $subject, any $search)<\/code><\/td>Returns true<\/code> if the given $subject<\/code> contains the provided $search<\/code> string.
If $subject<\/code> is an array, this function returns true if one of the elements in the array is equal to the provided $search<\/code> value.
If the provided $subject<\/code> is a string, this function returns true if the string contains the provided $search<\/code> argument.<\/td><\/tr>
ceil<\/a><\/td>number ceil(number $value)<\/code><\/td>Returns the next highest integer value by rounding up if necessary.<\/td><\/tr>
ends_with<\/a><\/td>boolean ends_with(string $subject, string $prefix)<\/code><\/td>Returns true<\/code> if the $subject<\/code> ends with the $prefix<\/code>, otherwise this function returns false<\/code>.<\/td><\/tr>
floor<\/a><\/td>number floor(number $value)<\/code><\/td>Returns the next lowest integer value by rounding down if necessary.<\/td><\/tr>
join<\/a><\/td>string join(string $glue, array[string] $stringsarray)<\/code><\/td>Returns all of the elements from the provided $stringsarray<\/code> array joined together using the $glue<\/code> argument as a separator between each.<\/td><\/tr>
keys<\/a><\/td>array keys(object $obj)<\/code><\/td>Returns an array containing the keys of the provided object. Note that because JSON hashes are inheritently unordered, the keys associated with the provided object obj<\/code> are inheritently unordered. Implementations are not required to return keys in any specific order.<\/td><\/tr>
length<\/a><\/td>number length(string|array|object $subject)<\/code><\/td>Returns the length of the given argument using the following types rules:
string: returns the number of code points in the string
array: returns the number of elements in the array
object: returns the number of key-value pairs in the object<\/td><\/tr>
map<\/a><\/td>array[any] map(expression-><\/strong>any-><\/strong>any expr, array[any] elements)<\/code><\/td>Apply the expr<\/code> to every element in the elements<\/code> array and return the array of results. An elements<\/code> of length N will produce a return array of length N.
Unlike a projection, ([*].bar<\/code>), map()<\/code> will include the result of applying the expr<\/code> for every element in the elements<\/code> array, even if the result if null<\/code>.<\/td><\/tr>
max<\/a><\/td>number max(array[number]|array[string] $collection)<\/code><\/td>Returns the highest found number in the provided array argument.
An empty array will produce a return value of null.<\/td><\/tr>
max_by<\/a><\/td>max_by(array elements, expression-><\/strong>number|<\/strong>expression-><\/strong>string expr)<\/code><\/td>Return the maximum element in an array using the expression expr<\/code> as the comparison key. The entire maximum element is returned. <\/td><\/tr>
merge<\/a><\/td>object merge([object *argument, [, object $...]])<\/code><\/td>Accepts 0 or more objects as arguments, and returns a single object with subsequent objects merged. Each subsequent object\u2019s key\/value pairs are added to the preceding object. This function is used to combine multiple objects into one. You can think of this as the first object being the base object, and each subsequent argument being overrides that are applied to the base object.<\/td><\/tr>
min<\/a><\/td>number min(array[number]|array[string] $collection)<\/code><\/td>Returns the lowest found number in the provided $collection<\/code> argument.<\/td><\/tr>
min_by<\/a><\/td>min_by(array elements, expression-><\/strong>number|<\/strong>expression-><\/strong>string expr)<\/code><\/td>Return the minimum element in an array using the expression expr<\/code> as the comparison key. The entire maximum element is returned. <\/td><\/tr>
not_null<\/a><\/td>any not_null([any $argument [, any $...]])<\/code><\/td>Returns the first argument that does not resolve to null<\/code>. This function accepts one or more arguments, and will evaluate them in order until a non null argument is encounted. If all arguments values resolve to null<\/code>, then a value of null<\/code> is returned.<\/td><\/tr>
reverse<\/a><\/td>array reverse(string|array $argument)<\/code><\/td>Reverses the order of the $argument<\/code>.<\/td><\/tr>
sort<\/a><\/td>array sort(array[number]|array[string] $list)<\/code><\/td>This function accepts an array $list<\/code> argument and returns the sorted elements of the $list<\/code> as an array.
The array must be a list of strings or numbers. Sorting strings is based on code points. Locale is not taken into account.<\/td><\/tr>
sort_by<\/a><\/td>sort_by(array elements, expression-><\/strong>number|<\/strong>expression-><\/strong>string expr)<\/code><\/td>Sort an array using an expression expr<\/code> as the sort key. For each element in the array of elements<\/code>, the expr<\/code> expression is applied and the resulting value is used as the key used when sorting the elements<\/code>.
If the result of evaluating the expr<\/code> against the current array element results in type other than a number<\/code> or a string<\/code>, an invalid-type<\/code> error will occur.<\/td><\/tr>
starts_with<\/a><\/td>boolean starts_with(string $subject, string $prefix)<\/code><\/td>Returns true<\/code> if the $subject<\/code> starts with the $prefix<\/code>, otherwise this function returns false<\/code>.<\/td><\/tr>
sum<\/a><\/td>number sum(array[number] $collection)<\/code><\/td>Returns the sum of the provided array argument.
An empty array will produce a return value of 0.<\/td><\/tr>
to_array<\/a><\/td>array to_array(any $arg)<\/code><\/td>array – Returns the passed in value.
number\/string\/object\/boolean – Returns a one element array containing the passed in argument.<\/td><\/tr>
to_string<\/a><\/td>string to_string(any $arg)<\/code><\/td>string – Returns the passed in value.
number\/array\/object\/boolean – The JSON encoded value of the object. The JSON encoder should emit the encoded JSON value without adding any additional new lines.<\/td><\/tr>
to_number<\/a><\/td>number to_number(any $arg)<\/code><\/td>string – Returns the parsed number. Any string that conforms to the\u00a0json-number<\/code>\u00a0production is supported.
number – Returns the passed in value.
array – null
object – null
boolean – null
null – null<\/td><\/tr>
type<\/a><\/td>string type(array|object|string|number|boolean|null $subject)<\/code><\/td>Returns the JavaScript type of the given $subject<\/code> argument as a string value.
The return value MUST be one of the following:
number
string
boolean
array
object
null<\/td><\/tr>
values<\/a><\/td>array values(object $obj)<\/code><\/td>Returns the values of the provided object. Note that because JSON hashes are inheritently unordered, the values associated with the provided object obj<\/code> are inheritently unordered. Implementations are not required to return values in any specific order. <\/td><\/tr><\/tbody><\/table><\/figure>\n","protected":false},"excerpt":{"rendered":"

While there are some extensions made to the JMESPath query language in DocuMotor, a lot of functionality is documented at jmespath.org. You can find information on each specific function by following the links below. JMESPath Reference Output abs number abs(number $value) Returns the absolute value of the provided argument. avg number avg(array[number] $elements) Returns the […]<\/p>\n","protected":false},"author":5,"featured_media":0,"parent":2252,"menu_order":60,"comment_status":"closed","ping_status":"closed","template":"","meta":[],"_links":{"self":[{"href":"https:\/\/info.documotor.com\/index.php?rest_route=\/wp\/v2\/pages\/5460"}],"collection":[{"href":"https:\/\/info.documotor.com\/index.php?rest_route=\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/info.documotor.com\/index.php?rest_route=\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/info.documotor.com\/index.php?rest_route=\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/info.documotor.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=5460"}],"version-history":[{"count":5,"href":"https:\/\/info.documotor.com\/index.php?rest_route=\/wp\/v2\/pages\/5460\/revisions"}],"predecessor-version":[{"id":5474,"href":"https:\/\/info.documotor.com\/index.php?rest_route=\/wp\/v2\/pages\/5460\/revisions\/5474"}],"up":[{"embeddable":true,"href":"https:\/\/info.documotor.com\/index.php?rest_route=\/wp\/v2\/pages\/2252"}],"wp:attachment":[{"href":"https:\/\/info.documotor.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=5460"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}