Class: CodeDefinitionsClient

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

Instance Method Summary collapse

Constructor Details

#initialize(lockstepsdk) ⇒ CodeDefinitionsClient

Initialize the CodeDefinitionsClient class with a lockstepsdk instance.

Parameters:

  • lockstepsdk (LockstepApi) —

    The Lockstep API client object for this connection



24
25
26
 
# File 'lib/lockstep_sdk/clients/code_definitions.rb', line 24

def initialize(lockstepsdk)
    @lockstepsdk = lockstepsdk
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](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:



52
53
54
55
56
 
# File 'lib/lockstep_sdk/clients/code_definitions.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}
    @lockstepsdk.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



35
36
37
38
39
 
# File 'lib/lockstep_sdk/clients/code_definitions.rb', line 35

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