Class: CodeDefinitionsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/lockstep_sdk/clients/code_definitions_client.rb

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ CodeDefinitionsClient

Initialize the CodeDefinitionsClient class with an API client instance.

Parameters:

  • connection (LockstepApi) —

    The API client object for this connection



22
23
24
 
# File 'lib/lockstep_sdk/clients/code_definitions_client.rb', line 22

def initialize(connection)
    @connection = connection
end

Instance Method Details

#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 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

  • 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

  • page_size (int32) —

    The page size for results (default 250, maximum of 500). See Searchlight Query Language

  • page_number (int32) —

    The page number for results (default 0). See Searchlight Query Language



52
53
54
55
56
 
# 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

#retrieve_codedefinition(id:, include_param:) ⇒ Object

Retrieves the CodeDefinition specified by this unique identifier, optionally including nested data sets.

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

Parameters:

  • id (uuid) —

    The unique Lockstep Platform ID number of this CodeDefinition

  • 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



34
35
36
37
38
 
# File 'lib/lockstep_sdk/clients/code_definitions_client.rb', line 34

def retrieve_codedefinition(id:, include_param:)
    path = "/api/v1/CodeDefinitions/#{id}"
    params = {:include => include_param}
    @connection.request(:get, path, nil, params)
end