Skip to content
Rymax One

Provides query results. Links build from NewJobQueryAction will link here.

GET
/api/WorkDataQuery/Query

Parameters

Query Parameters

Pagination.PageSize
integer format: int32
Pagination.PageOffset
integer format: int32
SortBy.PropertyName
string
Allowed values: Name MediaType Kind Size CreatedOn
SortBy.SortType
string
Allowed values: None Ascending Descending
Filter.NameContains
string
Filter.MediaTypeContains
string
Filter.TagsByAnd
Array<string>
Filter.TagsByOr
Array<string>
Filter.IsKind
string
Allowed values: Unknown ClientUpload ProcessingArtefact Monitoring
Filter.CreatedBefore
string format: date-time
Filter.CreatedAfter
string format: date-time

Responses

200

Returns the query result

object
class
Array<string>
nullable
title
string
nullable
properties
object
TotalEntities
required
integer format: int32
CurrentEntitiesCount
required
integer format: int32
entities
Array
nullable
actions
Array<object>
nullable
object
name
required
string
>= 1 characters
href
required
string
>= 1 characters
class
Array<string>
nullable
method
string
nullable
title
string
nullable
type
string
nullable
fields
Array<object>
nullable
object
name
required
string
>= 1 characters
type
string
nullable
value
nullable
class
Array<string>
nullable
title
string
nullable
links
Array<object>
nullable
object
rel
required
Array<string>
href
required
string
>= 1 characters
class
Array<string>
nullable
title
string
nullable
type
string
nullable
Example
{}

400

The querystring was malformed

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties

403

User has no permission to access the query

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties

500

Internal error

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties