Method: AppEnrollmentsClient#query_enrollment_fields

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

#query_enrollment_fields(id:) ⇒ Object

Queries custom fields settings for app enrollment within the Lockstep platform 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.

An App Enrollment represents an app that has been enrolled to the current account. When you sign up for an app using the Lockstep Platform, you obtain an enrollment record for that app. Example types of apps include connectors and feature enhancement apps. The App Enrollment object contains information about this app, its configuration, and settings.

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

Parameters:

  • id (uuid) —

    The unique ID number of the App Enrollment for which we retrieve custom fields



126
127
128
129
 
# File 'lib/lockstep_sdk/clients/app_enrollments_client.rb', line 126

def query_enrollment_fields(id:)
    path = "/api/v1/AppEnrollments/settings/#{id}"
    @connection.request(:get, path, nil, nil)
end