| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | query | Guid? | No | |
| RecIDIn | query | Guid[] | No | |
| QueueName | query | string | No | |
| QueueNameStartsWith | query | string | No | |
| QueueNameEndsWith | query | string | No | |
| QueueNameContains | query | string | No | |
| QueueNameLike | query | string | No | |
| QueueNameBetween | query | string[] | No | |
| QueueNameIn | query | string[] | No | |
| Identifier | query | string | No | |
| IdentifierStartsWith | query | string | No | |
| IdentifierEndsWith | query | string | No | |
| IdentifierContains | query | string | No | |
| IdentifierLike | query | string | No | |
| IdentifierBetween | query | string[] | No | |
| IdentifierIn | query | string[] | No | |
| QueueInsertionDateTime | query | DateTime? | No | |
| QueueInsertionDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
| QueueInsertionDateTimeGreaterThan | query | DateTime? | No | |
| QueueInsertionDateTimeLessThan | query | DateTime? | No | |
| QueueInsertionDateTimeLessThanOrEqualTo | query | DateTime? | No | |
| QueueInsertionDateTimeNotEqualTo | query | DateTime? | No | |
| QueueInsertionDateTimeBetween | query | DateTime[] | No | |
| QueueInsertionDateTimeIn | query | DateTime[] | No | |
| LastChangedDateTime | query | DateTime? | No | |
| LastChangedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
| LastChangedDateTimeGreaterThan | query | DateTime? | No | |
| LastChangedDateTimeLessThan | query | DateTime? | No | |
| LastChangedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
| LastChangedDateTimeNotEqualTo | query | DateTime? | No | |
| LastChangedDateTimeBetween | query | DateTime[] | No | |
| LastChangedDateTimeIn | query | DateTime[] | No | |
| Status | query | byte? | No | |
| StatusGreaterThanOrEqualTo | query | byte? | No | |
| StatusGreaterThan | query | byte? | No | |
| StatusLessThan | query | byte? | No | |
| StatusLessThanOrEqualTo | query | byte? | No | |
| StatusNotEqualTo | query | byte? | No | |
| StatusBetween | query | byte[] | No | |
| StatusIn | query | byte[] | No | |
| ExceptionText | query | string | No | |
| ExceptionTextStartsWith | query | string | No | |
| ExceptionTextEndsWith | query | string | No | |
| ExceptionTextContains | query | string | No | |
| ExceptionTextLike | query | string | No | |
| ExceptionTextBetween | query | string[] | No | |
| ExceptionTextIn | query | string[] | No | |
| RowHash | query | byte[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | form | Guid | No | |
| QueueName | form | string | No | |
| Identifier | form | string | No | |
| QueueInsertionDateTime | form | DateTime | No | |
| LastChangedDateTime | form | DateTime | No | |
| Status | form | byte | No | |
| ExceptionText | form | string | No | |
| RowHash | form | byte[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<T> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/Magento_QueueQuery HTTP/1.1
Host: localhost
Accept: application/json
Content-Type: application/json
Content-Length: length
{"RecID":"00000000000000000000000000000000","RecIDIn":["00000000-0000-0000-0000-000000000000"],"QueueName":"String","QueueNameStartsWith":"String","QueueNameEndsWith":"String","QueueNameContains":"String","QueueNameLike":"String","QueueNameBetween":["String"],"QueueNameIn":["String"],"Identifier":"String","IdentifierStartsWith":"String","IdentifierEndsWith":"String","IdentifierContains":"String","IdentifierLike":"String","IdentifierBetween":["String"],"IdentifierIn":["String"],"QueueInsertionDateTime":"0001-01-01T00:00:00.0000000","QueueInsertionDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","QueueInsertionDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","QueueInsertionDateTimeLessThan":"0001-01-01T00:00:00.0000000","QueueInsertionDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","QueueInsertionDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","QueueInsertionDateTimeBetween":["0001-01-01T00:00:00.0000000"],"QueueInsertionDateTimeIn":["0001-01-01T00:00:00.0000000"],"LastChangedDateTime":"0001-01-01T00:00:00.0000000","LastChangedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastChangedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","LastChangedDateTimeLessThan":"0001-01-01T00:00:00.0000000","LastChangedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastChangedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","LastChangedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"LastChangedDateTimeIn":["0001-01-01T00:00:00.0000000"],"Status":0,"StatusGreaterThanOrEqualTo":0,"StatusGreaterThan":0,"StatusLessThan":0,"StatusLessThanOrEqualTo":0,"StatusNotEqualTo":0,"StatusBetween":"AA==","StatusIn":"AA==","ExceptionText":"String","ExceptionTextStartsWith":"String","ExceptionTextEndsWith":"String","ExceptionTextContains":"String","ExceptionTextLike":"String","ExceptionTextBetween":["String"],"ExceptionTextIn":["String"],"RowHash":"AA==","Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Results":[{"QueueName":"String","Identifier":"String","ExceptionText":"String","RowHash":"AA=="}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}