ActivitiesActivity.md

Falcon::ActivitiesActivity

Properties

Name	Type	Description	Notes
api_scope	String	Required api scope to use this activity.	[optional]
app_id	String	Optional ID if the activity is exposed through an app from Store	[optional]
cid	String	The CID that owns this activity, if this is empty it is a global activity
_class	String	Activity class to identify how it should be orchestrated. E.g. External, Break, CreateVariable and UpdateVariable	[optional]
description	String	A detailed description of what this action does
disruptive	Boolean	A flag indicating whether the activity is potentially disruptive/destructive
has_permission	Boolean	Indicates whether an activity is available for the caller
id	String	Unique ID of the activity, auto-generated by the API service
input_fields	Array<ActivitiesActivityExtField>	Input fields required for configuring activity	[optional]
input_schema	JsonschemaSchema		[optional]
mock_output	Object		[optional]
name	String	UI name for displaying the activity to a user
namespace	String	Unique namespace for the activity.	[optional]
output_fields	Array<ActivitiesActivityExtField>	Output fields of the activity once executed	[optional]
output_schema	JsonschemaSchema		[optional]
tag_ids	Array<String>	Tag IDs assigned to this activity	[optional]
updated	Time	Timestamp of when the activity was last updated	[optional]
use_cases	Array<String>	UseCases used by this activity	[optional]
vendor	String	Vendors used by this activity	[optional]
version	Integer	An incrementing version number	[optional]

Example

require 'crimson-falcon'

instance = Falcon::ActivitiesActivity.new(
  api_scope: null,
  app_id: null,
  cid: null,
  _class: null,
  description: null,
  disruptive: null,
  has_permission: null,
  id: null,
  input_fields: null,
  input_schema: null,
  mock_output: null,
  name: null,
  namespace: null,
  output_fields: null,
  output_schema: null,
  tag_ids: null,
  updated: null,
  use_cases: null,
  vendor: null,
  version: null
)