List the instances of a Decision Application

Source: R/generated_client.R

List the instances of a Decision Application

apps_list_instances(
  slug,
  archived = NULL,
  app_release_id = NULL,
  limit = NULL,
  page_num = NULL,
  order = NULL,
  order_dir = NULL
)

Arguments

slug

string required. The slug for the application.
archived

string optional. The archival status of the requested item(s).
app_release_id

integer optional. If supplied, return only instances matching this release.
limit

integer optional. Number of results to return. Defaults to its maximum of 50.
page_num

integer optional. Page number of the results to return. Defaults to the first page, 1.
order

string optional. The field on which to order the result set. Defaults to id. Must be one of: id, created_at.
order_dir

string optional. Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.

Value

An array containing the following fields:

id

integer, The unique id of the instance.

name

string, The name of the instance.

appReleaseId

integer, The id of the app release the instance belongs to.

reportId

integer, The id of the report the instance belongs to.

createdAt

string, The time the instance was created at.

user

list, A list containing the following elements:

  • id integer, The ID of this user.

  • name string, This user's name.

  • username string, This user's username.

  • initials string, This user's initials.

  • online boolean, Whether this user is online.

projectId

integer, The id of the project collecting all the items that belong to this app instance.

archived

string, The archival status of the requested item(s).