Method: CodeDefinitionsClient#query_codedefinitions

Defined in:

lib/lockstep_sdk/clients/code_definitions_client.rb

#query_codedefinitions(filter:, include_param:, order:, page_size:, page_number:) ⇒ Object

Queries CodeDefinitions for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.

More information on querying can be found on the [Searchlight Query Language](developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.

A CodeDefinition contains information around system code values and their definitions.

Parameters:

• filter (string) —

  The filter for this query. See [Searchlight Query Language](developer.lockstep.io/docs/querying-with-searchlight)

• include_param (string) —

  To fetch additional data on this object, specify the list of elements to retrieve. No collections are currently available but may be offered in the future

• order (string) —

  The sort order for this query. See See [Searchlight Query Language](developer.lockstep.io/docs/querying-with-searchlight)

• page_size (int32) —

  The page size for results (default 250, maximum of 500). See [Searchlight Query Language](developer.lockstep.io/docs/querying-with-searchlight)

• page_number (int32) —

  The page number for results (default 0). See [Searchlight Query Language](developer.lockstep.io/docs/querying-with-searchlight)

# File 'lib/lockstep_sdk/clients/code_definitions_client.rb', line 52

def query_codedefinitions(filter:, include_param:, order:, page_size:, page_number:)
    path = "/api/v1/CodeDefinitions/query"
    params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
    @connection.request(:get, path, nil, params)
end