Method: ApplicationsClient#retrieve_application

Defined in:
lib/lockstep_sdk/clients/applications_client.rb

#retrieve_application(id:, include_param:) ⇒ Object

Retrieves the Application with this identifier.

An Application represents a feature available to customers within the Lockstep Platform. You can create Applications by working with your Lockstep business development manager and publish them on the platform so that customers can browse and find your Application on the Lockstep Platform Marketplace. When a customer adds an Application to their account, they obtain an AppEnrollment which represents that customer’s instance of this Application. The customer-specific AppEnrollment contains a customer’s configuration data for the Application, which is not customer-specific.

See [Applications and Enrollments](developer.lockstep.io/docs/applications-and-enrollments) for more information.

Parameters:

  • id (uuid) —

    The unique ID number of the Application to retrieve

  • include_param (string) —

    To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Notes, Attachments, CustomFields



36
37
38
39
40
 
# File 'lib/lockstep_sdk/clients/applications_client.rb', line 36

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