apps_put_instances_archive: Update the archive status of this object

Description Usage Arguments Value

View source: R/generated_client.R

Description

Update the archive status of this object

Usage

1
apps_put_instances_archive(id, slug, status)

Arguments

id

integer required. The ID of the object.

slug

string required. The slug for the application.

status

boolean required. The desired archived status of the object.

Value

A list containing the following elements:

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.

authCodeUrl

string,

apiKey

string, A Civis API key that can be used by this app instance.

archived

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


civis documentation built on July 2, 2020, 12:44 a.m.