BYbymason
Command APIs

Retrieve a list of commands based on various filters.

This API retrieves a list of commands based on the provided filters. It supports pagination and filtering by action, search string, search type, search column, and more.

post/rest/command/getcommands

Request

  • Base URL
    https://masonconsole.com
  • Auth
    HTTP bearer

Query parameters

startIndexinteger required

The index from which to start retrieving commands in the paginated result.

pageSizeinteger required

The number of commands to include in each page of the paginated result.

actionstring

Filter commands by a specific action.

searchstringstring

A string to search for within the commands.

searchTypestring

The type of search to perform (e.g., exact match, partial match).

searchcolumnstring

The specific column to search within the commands.

withgrouppackagesboolean

Indicates whether to include group packages along with individual commands (default is false).

v2boolean

Indicates whether to use version 2 of the API (default is false).

Request body

propertystring

The property to sort by.

directionstring

The sorting direction (e.g., ASC or DESC).

searchlistobject

A HashMap for additional search parameters.

Response

Successful response

messagestring
resultstring
totalRecordCountinteger

Changes

No recorded changes to this operation across all 1 revision of this API.