Skip to content
Rymax One

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

GET
/api/JobQuery/Query

Parameters

Query Parameters

Pagination.PageSize
integer format: int32
Pagination.PageOffset
integer format: int32
SortBy.PropertyName
string
Allowed values: Name CreatedOn CompletedOn
SortBy.SortType
string
Allowed values: None Ascending Descending
Filter.State
string
Allowed values: Undefined Created ReadyForProcessing Pending Processing Completed Error Canceled DataMissing
Filter.Name
string
Filter.ShowDeleted
boolean

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
{
  "class": [
    "JobQueryResult",
    "QueryResult"
  ],
  "title": "Query result for jobs with applied filters and sorting.",
  "properties": {
    "TotalEntities": 3,
    "CurrentEntitiesCount": 2
  },
  "entities": [
    {
      "class": [
        "Job"
      ],
      "title": "A Job for the system. Provides access to job lifetime, information and operations",
      "rel": [
        "item"
      ],
      "properties": {
        "Name": "New Job",
        "State": "Created"
      },
      "entities": [],
      "actions": [
        {
          "name": "Delete",
          "title": "Delete this job.",
          "method": "DELETE",
          "href": "http://localhost:80/api/Job/4575f13c-960f-4f58-a891-b684c202d471/DeleteJob",
          "class": [
            "ParameterLessAction"
          ]
        },
        {
          "name": "Rename",
          "title": "Rename this job.",
          "method": "POST",
          "href": "http://localhost:80/api/Job/4575f13c-960f-4f58-a891-b684c202d471/RenameJob",
          "type": "application/json",
          "class": [
            "ParameterAction"
          ],
          "fields": [
            {
              "name": "RenameJobParameters",
              "type": "application/json",
              "class": [
                "http://localhost:80/ActionParameterTypes/RenameJobParameters"
              ],
              "value": {
                "NewName": "New Job"
              }
            }
          ]
        }
      ],
      "links": [
        {
          "rel": [
            "self"
          ],
          "href": "http://localhost:80/api/Job/4575f13c-960f-4f58-a891-b684c202d471"
        },
        {
          "rel": [
            "WorkData"
          ],
          "href": "http://localhost:80/api/4575f13c-960f-4f58-a891-b684c202d471/WorkData/00000000-0000-0000-0000-000000000000"
        }
      ]
    },
    {
      "class": [
        "Job"
      ],
      "title": "A Job for the system. Provides access to job lifetime, information and operations",
      "rel": [
        "item"
      ],
      "properties": {
        "Name": "Job 1",
        "State": "Created"
      },
      "entities": [],
      "actions": [
        {
          "name": "Delete",
          "title": "Delete this job.",
          "method": "DELETE",
          "href": "http://localhost:80/api/Job/199e39de-1ac7-49b7-99bd-c2dca11f3fc0/DeleteJob",
          "class": [
            "ParameterLessAction"
          ]
        },
        {
          "name": "Rename",
          "title": "Rename this job.",
          "method": "POST",
          "href": "http://localhost:80/api/Job/199e39de-1ac7-49b7-99bd-c2dca11f3fc0/RenameJob",
          "type": "application/json",
          "class": [
            "ParameterAction"
          ],
          "fields": [
            {
              "name": "RenameJobParameters",
              "type": "application/json",
              "class": [
                "http://localhost:80/ActionParameterTypes/RenameJobParameters"
              ],
              "value": {
                "NewName": "Job 1"
              }
            }
          ]
        }
      ],
      "links": [
        {
          "rel": [
            "self"
          ],
          "href": "http://localhost:80/api/Job/199e39de-1ac7-49b7-99bd-c2dca11f3fc0"
        },
        {
          "rel": [
            "WorkData"
          ],
          "href": "http://localhost:80/api/199e39de-1ac7-49b7-99bd-c2dca11f3fc0/WorkData/00000000-0000-0000-0000-000000000000"
        }
      ]
    }
  ],
  "actions": [],
  "links": [
    {
      "rel": [
        "self"
      ],
      "href": "http://localhost:80/api/JobQuery/Query?Pagination.PageSize=2&SortBy.PropertyName=CreatedOn&SortBy.SortType=Descending&Filter.State=Created"
    },
    {
      "rel": [
        "all"
      ],
      "href": "http://localhost:80/api/JobQuery/Query?SortBy.PropertyName=CreatedOn&SortBy.SortType=Descending&Filter.State=Created"
    },
    {
      "rel": [
        "first"
      ],
      "href": "http://localhost:80/api/JobQuery/Query?Pagination.PageSize=2&SortBy.PropertyName=CreatedOn&SortBy.SortType=Descending&Filter.State=Created"
    },
    {
      "rel": [
        "next"
      ],
      "href": "http://localhost:80/api/JobQuery/Query?Pagination.PageSize=2&Pagination.PageOffset=2&SortBy.PropertyName=CreatedOn&SortBy.SortType=Descending&Filter.State=Created"
    },
    {
      "rel": [
        "last"
      ],
      "href": "http://localhost:80/api/JobQuery/Query?Pagination.PageSize=2&Pagination.PageOffset=1&SortBy.PropertyName=CreatedOn&SortBy.SortType=Descending&Filter.State=Created"
    }
  ]
}

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