Param Name | Description |
---|---|
search Optional |
filter results Value: Must be String |
order Optional |
sort results Value: Must be String |
page Optional |
paginate results Value: Must be String |
per_page Optional |
number of entries per request Value: Must be String |
Param Name | Description |
---|---|
id Required |
Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space. |
Param Name | Description |
---|---|
job_invocation Required |
Value: Must be a Hash |
job_invocation[job_name] Required |
Job name Value: Must be String |
job_invocation[template_id] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
If using a specific template, the id of that template. Value: Must be String |
job_invocation[targeting_type] Required |
Invocation type, one of {"static_query"=>"Static Query", "dynamic_query"=>"Dynamic Query"} Value: Must be String |
job_invocation[inputs] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
Inputs to use Value: Must be an Array of nested elements |
job_invocation[inputs][name] Required |
Value: Must be String |
job_invocation[inputs][value] Required |
Value: Must be String |
job_invocation[bookmark_id] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
Value: Must be Integer |
job_invocation[search_query] Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span> |
Value: Must be Integer |