プレイブック GraphQL API🔗

クエリ🔗

説明: Red Cloak TDR APIはGraphQLに基づいており、読み取り（Query）または書き込み（Mutation）操作のいずれかです。GraphQLクエリは値の読み取りや取得に使用され、ミューテーションは値の書き込みや投稿に使用されます。レスポンスはJSON形式で提供されます。

フィールド🔗

フィールド	型	説明	引数
node	Node		id: ID
tenantContext	TenantContext
playbook	Playbook		playbookId: ID
playbookV2	Playbook		arguments: PlaybookArguments
playbooks	Playbook		categoryId: ID, tags: Tags
playbooksV2	Playbook		arguments: PlaybooksV2Arguments
playbookList	PlaybooksListResults		arguments: PlaybookListArguments
playbookVersion	PlaybookVersion		arguments: PlaybookVersionArguments
playbookVersions	PlaybookVersion		arguments: PlaybookVersionsArguments
playbookInstance	PlaybookInstance		playbookInstanceId: ID
playbookInstances	PlaybookInstance		playbookInstanceIds: ID, playbookId: ID, tags: Tags, connections: IDs
playbookInstancesV2	PlaybookInstance		arguments: PlaybookInstancesArguments
playbookInstanceList	PlaybookInstancesListResults		arguments: PlaybookInstanceListArguments
playbookExecution	PlaybookExecution		playbookExecutionId: ID
playbookExecutions	PlaybookExecutions		playbookInstanceId: ID, pagination: Pagination
playbookExecutionsV2	PlaybookExecutionsV2		arguments: PlaybookExecutionsV2Arguments
playbookExecutionLogs	PlaybookExecutionLog		playbookExecutionId: ID
playbookTrigger	PlaybookTrigger		playbookTriggerId: ID
playbookTriggers	PlaybookTrigger		playbookTriggerTypeIds: IDs
playbookTriggersV2	PlaybookTrigger		arguments: PlaybookTriggersV2Arguments
playbookRuntimeTriggers	PlaybookTrigger		arguments: PlaybookTriggersV3Arguments
playbookTriggerType	PlaybookTriggerType		playbookTriggerTypeId: ID, playbookTriggerTypeName: String
playbookTriggerTypesV2	PlaybookTriggerType		arguments: PlaybookTriggerTypesV2Arguments
playbookTriggerTypes	PlaybookTriggerType	データベースに保存されている設定に基づいてトリガー設定を返します。
playbookTriggerConfiguration	PlaybookTriggerType	内省を通じてトリガー設定を返します。
playbookExport	PlaybookExport		arguments: PlaybookExportArguments
playbookTags	String
playbookQuery	PlaybookStatistics		query: String, database: String, options: QueryOptions
playbookQueryV2	PlaybookStatistics		query: String, database: String, options: QueryOptions
playbookQueryV3	PlaybooksQLResponse	QL（別名CQL）クエリを実行し、現在のプレイブックCQLスキーマタイプに対する集計および検索の両方の結果を取得します	input: PlaybooksQLInput
playbookInterface	PlaybookInterface		arguments: PlaybookInterfaceArguments
playbookInterfaces	PlaybookInterface		arguments: PlaybookInterfacesArguments
playbookInterfaceVersion	PlaybookInterfaceVersion		arguments: PlaybookInterfaceVersionArguments
playbookInterfaceVersions	PlaybookInterfaceVersion		arguments: PlaybookInterfaceVersionsArguments
playbookInterfaceExport	PlaybookInterfaceExport		arguments: PlaybookInterfaceExportArguments
playbooksImplementingInterface	Playbook		arguments: PlaybooksImplementingArguments
playbookVersionsImplementingInterfaceVersions	PlaybookInterfaceVersionPlaybookVersions		arguments: PlaybooksImplementingArguments
playbookActivities	PlaybookActivityList	設定済みのアクティビティおよび設定可能なアクティビティを返します	arguments: PlaybookActivityArguments
playbookQueueStats	PlaybookQueueStatistics	プレイブックキュー統計情報を返します
playbookTriggerFilters	PlaybookTriggerFilter	トリガープラットフォームフィルターを返します
playbookSchedule	PlaybookSchedule	単一のプレイブックスケジュールを取得します	arguments: PlaybookScheduleArguments
playbookSchedules	PlaybookSchedulesResults	プレイブックスケジュールの一覧	arguments: PlaybookSchedulesArguments
reconcileInstanceVersions	PlaybookInstance	既存インスタンスとのバージョン変更を調整します	arguments: ReconcileInstanceVersionsArguments
playbookValidateDSLV2	PlaybookDSLValidation	DSLおよびタスクを検証します	arguments: PlaybookValidationArgumentsV2

ID🔗

説明: IDスカラ型は一意の識別子を表し、オブジェクトの再取得やキャッシュのキーとしてよく使用されます。ID型はJSONレスポンスではStringとして表示されますが、人間が読めることを意図していません。入力型として期待される場合、任意の文字列（例: "4"）や整数（例: 4）の入力値がIDとして受け入れられます。

String🔗

説明: Stringスカラ型はテキストデータを表し、UTF-8文字列として表現されます。String型はGraphQLで自由形式の人間が読めるテキストを表現するためによく使用されます。

TenantContext🔗

フィールド🔗

フィールド	型	説明	引数
id	String
name	String
rccID	String
ctpID	String

PlaybookArguments🔗

説明: PlaybookArgumentsは、単一のプレイブックを検索するために利用可能なフィールドを定義します。 playbookIdまたはplaybookNameのいずれかを必ず設定する必要があります。両方が設定されている場合、idとnameの両方が既存のプレイブックと一致する必要があります。

フィールド🔗

フィールド	型	説明
playbookId	ID
playbookName	String
simplified	Boolean	オプション - 指定されてtrueの場合、簡易化としてマークされたプレイブックインスタンスのみが返されます

Boolean🔗

説明: Booleanスカラ型はtrueまたはfalseを表します。

PlaybooksV2Arguments🔗

フィールド🔗

フィールド	型	説明
playbookIds	ID
categoryId	ID
tags	Tags
createdAfter	Time
createdBefore	Time
sortBy	PlaybooksSortField	ソートフィールド。デフォルトはNAME。
orderBy	PaginationOrder	プレイブックリストのソート順。デフォルトは昇順
isDeprecated	Boolean

PlaybookListArguments🔗

説明: PlaybookListArgumentsはプレイブック一覧取得のパラメータを記述します

フィールド🔗

フィールド	型	説明	引数
page	Int
perPage	Int
sortField	PlaybooksSortField
order	PaginationOrder
searchText	String
tags	Tags
simplifiedTypes	SimplifiedType
isDeprecated	Boolean
isGlobal	Boolean
simplifiedType	SimplifiedType

Int🔗

説明: Intスカラ型は符号付きの非小数整数値を表します。Intは-(2^31)から2^31 - 1までの値を表現できます。

PlaybooksListResults🔗

説明: PlaybooksListResultsはList Playbooks APIアクションの1セットの結果です

フィールド🔗

フィールド	型	説明	引数
results	Playbook
count	Int

PlaybookInstanceListArguments🔗

説明: PlaybookInstanceListArgumentsはプレイブックインスタンス一覧取得のパラメータを記述します。 connectionsが含まれている場合、それらのconnectionsを直接使用しているプレイブックインスタンス、またはそれらのconnectionsを使用しているプレイブックインスタンスアクティビティが返されます。

フィールド🔗

フィールド	型	説明
page	Int
perPage	Int
sortField	PlaybookInstancesSortField
order	PaginationOrder
searchText	String
tags	Tags
enabled	Boolean
playbooks	IDs	オプションのプレイブックIDリスト。リストにはこれらのプレイブックに基づくプレイブックインスタンスが含まれます。
connections	IDs	オプションのコネクションIDリスト。リストにはこれらのコネクションを直接またはアクティビティ経由で使用するプレイブックインスタンスが含まれます。
simplified	Boolean	オプションフラグ - trueの場合、簡易化プレイブックに基づくインスタンスのみ返します

PlaybookInstancesListResults🔗

説明: PlaybookInstancesListResultsはList Playbooks APIアクションの1セットの結果です

フィールド🔗

フィールド	型	説明	引数
results	PlaybookInstance
count	Int

PlaybookInstancesArguments🔗

説明: PlaybookInstancesArgumentsはプレイブックインスタンスのリストを検索するためのフィールドを定義します。すべてのフィールドはオプションです。connectionsが含まれている場合、それらのconnectionsを直接使用しているプレイブックインスタンス、またはそれらのconnectionsを使用しているプレイブックインスタンスアクティビティが返されます。

フィールド🔗

フィールド	型	説明	引数
playbookInstanceIds	ID
playbookId	ID
tags	Tags
connections	IDs
sortBy	InstanceSortField
orderBy	PaginationOrder
page	Int
perPage	Int

PlaybookVersionArguments🔗

説明: PlaybookVersionArgumentsは、単一のプレイブックを検索するために利用可能なフィールドを定義します。 playbookVersionIdまたはplaybookVersionNameのいずれかを必ず設定する必要があります。両方が設定されている場合、idとnameの両方が既存のプレイブックと一致する必要があります。

フィールド🔗

フィールド	型	説明	引数
playbookVersionId	ID
playbookVersionName	String

PlaybookVersionsArguments🔗

フィールド🔗

フィールド	型	説明	引数
playbookVersionIds	ID
connectorVersionIds	ID

PlaybookTriggersV2Arguments🔗

フィールド🔗

フィールド	型	説明
playbookTriggerIds	ID
playbookTriggerTypeIds	ID
enabled	Boolean	trueの場合、有効なトリガーのみ返します。可能であればキャッシュされた結果を返します。

PlaybookTriggersV3Arguments🔗

フィールド🔗

フィールド	型	説明	引数
triggerType	String

PlaybookTriggerTypesV2Arguments🔗

フィールド🔗

フィールド	型	説明	引数
playbookTriggerTypeIds	ID

PlaybookExportArguments🔗

フィールド🔗

フィールド	型	説明
playbookId	ID
name	String
playbookVersionId	ID	オプション - 設定されている場合、指定されたバージョンIDでエクスポートします。未設定の場合は最新バージョンがデフォルトとなります。 versionとplaybookVersionIdの両方が設定されている場合、playbookVersionIdが優先されます。
version	SemVer	オプション - 設定されている場合、指定されたsemverバージョンでエクスポートします。未設定の場合は最新バージョンがデフォルトとなります。 versionとplaybookVersionIdの両方が設定されている場合、このフィールドよりplaybookVersionIdが優先されます。

PlaybookInterfaceArguments🔗

説明: PlaybookInterfaceArgumentsは、単一のPlaybookInterfaceを検索するためのフィールドを定義します。 playbookInterfaceIdまたはplaybookInterfaceNameのいずれかを必ず設定する必要があります。両方が設定されている場合、idとnameの両方が既存のPlaybookInterfaceと一致する必要があります。

フィールド🔗

フィールド	型	説明	引数
playbookInterfaceId	ID
playbookInterfaceName	String

PlaybookInterfacesArguments🔗

説明: PlaybookInterfacesArgumentsは複数のPlaybookInterfaceを検索するためのフィールドを定義します。

フィールド🔗

フィールド	型	説明	引数
playbookInterfaceIds	ID
tags	Tags

PlaybookInterfaceVersionArguments🔗

説明: PlaybookInterfaceVersionArgumentsは、単一のPlaybookInterfaceVersionを検索するためのフィールドを定義します。 playbookInterfaceVersionIdまたはplaybookInterfaceVersionNameのいずれかを必ず設定する必要があります。両方が設定されている場合、idとnameの両方が既存のPlaybookInterfaceVersionと一致する必要があります。

フィールド🔗

フィールド	型	説明	引数
playbookInterfaceVersionId	ID
playbookInterfaceVersionName	String

PlaybookInterfaceVersionsArguments🔗

説明: PlaybookInterfaceVersionsArgumentsはPlaybookInterfaceVersionsのリストを検索するためのフィールドを定義します。すべてのパラメータはオプションです。playbookInterfaceIDが指定されている場合、そのPlaybookInterface IDに一致するすべてのPlaybookInterfaceVersionsが一致します。 playbookInterfaceVersionNamesが指定されている場合、PlaybookInterfaceVersionsまたはPlaybookInterfacesの名前がこのリストと一致する必要があります。両方のパラメータを指定できますが、ほとんどの場合はどちらか一方のみが使用されます。

フィールド🔗

フィールド	型	説明	引数
playbookInterfaceVersionIds	ID
playbookInterfaceId	ID
playbookInterfaceVersionNames	String

PlaybookInterfaceExportArguments🔗

フィールド🔗

フィールド	型	説明	引数
playbookInterfaceId	ID
playbookInterfaceName	String

PlaybookExecutionsV2Arguments🔗

フィールド🔗

フィールド	型	説明
first	Int	最初のn件の結果を返します（順方向のページングに使用）
after	String	firstと組み合わせて次のページの結果を取得するために使用します。現在のページのendCursorの後（順方向のページングに使用）
last	Int	beforeと組み合わせて前のページの最後のn件の結果を返します（逆方向のページングに使用）
before	String	前のページの結果を取得するために使用します。現在のページのstartCursorの前（逆方向のページングに使用）
sortBy	PlaybookExecutionsSort
orderBy	PaginationOrder
playbookInstanceId	ID
playbookVersionId	ID
state	PlaybookState
states	PlaybookState
createdAtFrom	Time
createdAtTo	Time
updatedAtFrom	Time
updatedAtTo	Time
executionIDs	ID
targetResourceIDs	String
triggerContext	String
triggerCategory	String

PlaybookValidationArguments🔗

説明: PlaybookValidationInputはプレイブックを検証するために必要な入力を定義します。これらのフィールドのうち1つだけが使用されます。両方が指定されている場合は"file"の値が使用されます。

フィールド🔗

フィールド	型	説明	引数
file	Upload
yaml	String

PlaybookValidationArgumentsV2🔗

説明: PlaybookValidationArgumentsV2はプレイブックを検証するために必要な入力を定義します。"yaml"または"file" フィールドのいずれかが使用されます。両方が指定されている場合は"file"の値が使用されます。

フィールド🔗

フィールド	型	説明	引数
file	Upload
yaml	String
connectors	ID
playbooks	ID
interfaces	ID

PlaybooksImplementingArguments🔗

説明: PlaybookImplementsArgumentsは、インターフェースバージョンを実装しているプレイブックを検索するためのインターフェースバージョンのリストを定義します。インターフェースバージョンのIDまたは名前のいずれかを指定できます。両方が指定されている場合はIDのみが使用されます。

フィールド🔗

フィールド	型	説明	引数
playbookInterfaceVersionIDs	ID
playbookInterfaceVersionNames	String

PlaybookActivityArguments🔗

説明: PlaybookActivityArgumentsは、簡易化プレイブック設定で使用されるプレイブックに関する情報を取得するための引数を定義します。プレイブックが簡易化タイプをサポートしていない場合はエラーが返されます。

フィールド🔗

フィールド	型	説明	引数
playbookID	ID	プレイブックID
playbookInstanceId	ID	プレイブックインスタンスID

PlaybookValidationError🔗

説明: PlaybookValidationErrorはプレイブックDSL（フォーマット/値の欠落など）で検出されたエラーを表します

フィールド🔗

フィールド	型	説明	引数
message	String
lineno	Int

PlaybookDSLValidation🔗

フィールド🔗

フィールド	型	説明	引数
errors	PlaybookValidationError
warnings	PlaybookValidationError
dsl	JSONObject

PlaybookExecutionsSort🔗

説明: PlaybookExecutionsOrderはPlaybookExecutionsの結果をソートするために使用できるフィールドを定義します

PaginationOrder🔗

説明: PaginationOrderは結果を昇順または降順で並べ替えるために使用できるフィールドを定義します。 ASCENDINGがデフォルトです。

PlaybooksSortField🔗

説明: PlaybooksSortFieldはプレイブックのリストを取得する際のソート順を決定します。ソートフィールドが指定されていない場合、リストはNAMEでソートされます。

PlaybookInstancesSortField🔗

説明: PlaybookInstancesSortFieldはプレイブックインスタンスのリストを取得する際のソート順を決定します。ソートフィールドが指定されていない場合、リストはNAMEでソートされます。

InstanceSortField🔗

説明: InstanceSortFiledはプレイブックインスタンスのリストを取得する際のソート順を決定します。ソートフィールドが指定されていない場合、リストはNAMEでソートされます。

PlaybookExport🔗

フィールド🔗

フィールド	型	説明	引数
export	String

PlaybookInterfaceExport🔗

フィールド🔗

フィールド	型	説明	引数
export	String

Node🔗

フィールド🔗

フィールド	型	説明	引数
id	ID

TDRUser🔗

説明: NautilusでRed Cloak TDRユーザーモデルを解決するために使用されます。

フィールド🔗

フィールド	型	説明	引数
id	ID

ConnectorCategory🔗

説明: ConnectorCategoryは利用可能なコネクター/プレイブックのグループ化/カテゴリ分けです（例: IPレピュテーションサービス、DNSルックアップなど）

フィールド🔗

フィールド	型	説明	引数
id	ID

ConnectorInterface🔗

説明: ConnectorInterfaceは複数のコネクターによって実装可能な抽象インターフェース（アクションのセット）を定義します

フィールド🔗

フィールド	型	説明	引数
id	ID

ConnectorVersion🔗

説明: ConnectorVersionはコネクターインターフェースのバージョン属性を含みます

フィールド🔗

フィールド	型	説明	引数
id	ID

Connector🔗

説明: Connectorは利用可能なコネクターのカタログエントリです（例: generic http connectorサービスに基づくservice now connector）

フィールド🔗

フィールド	型	説明	引数
id	ID

Connection🔗

説明: Connectionはテナントごとのコネクター/アクションの設定です

フィールド🔗

フィールド	型	説明	引数
id	ID

PlaybookTriggerType🔗

説明: PlaybookTriggerTypeは利用可能なトリガーメカニズムを定義します

フィールド🔗

フィールド	型	説明	引数
id	ID
createdAt	Time
createdBy	String
createdBySubject	Subject
updatedAt	Time
updatedBy	String
updatedBySubject	Subject
name	String
description	String
parameters	JSONSchema

PlaybookTrigger🔗

説明: PlaybookTriggerは異なるトリガータイプに共通する属性のセットを定義します

フィールド🔗

フィールド	型	説明
id	ID
createdAt	Time
createdBy	String
createdBySubject	Subject
updatedAt	Time
updatedBy	String
updatedBySubject	Subject
name	String
description	String
tenant	String
type	PlaybookTriggerType
config	JSONObject
isPreApproved	Boolean	このアクションが事前承認アクションであることを示します
approvedBy	String	トリガーが事前承認されている場合、このフィールドは事前承認を作成または設定したユーザーを保持します
approvedBySubject	Subject	トリガーが事前承認されている場合、このフィールドは事前承認を作成または設定したサブジェクトを保持します
instance	PlaybookInstance
rn	RN
updatedByUser	TDRUser	非推奨: 使用しないでください
createdByUser	TDRUser

PlaybookTriggerFilter🔗

説明: PlaybookTriggerFilterは、トリガープラットフォームによって不要なイベントを除外するために使用される式を定義します。イベント評価中に、イベントがこれらのフィルターのいずれかに一致した場合、スキップされ、トリガーは実行されません。トリガーフィルターはグローバルですが、フィルターがサーキットブレーカーイベントの結果として作成された場合、テナントはルールのテナントを示します。

フィールド🔗

フィールド	型	説明
id	ID
createdAt	Time
createdBy	String
createdBySubject	Subject
updatedAt	Time
updatedBy	String
updatedBySubject	Subject
name	String
description	String
tenant	String
config	JSONObject
ruleId	ID
updatedByUser	TDRUser	非推奨: 使用しないでください
createdByUser	TDRUser

PlaybookInterface🔗

説明: PlaybookInterfaceは1つ以上のプレイブックによって実装可能な契約を定義します

フィールド🔗

フィールド	型	説明
id	ID
createdAt	Time
createdBy	String
createdBySubject	Subject
updatedAt	Time
updatedBy	String
updatedBySubject	Subject
name	String
tenant	String
tags	String
head	PlaybookInterfaceVersion
versions	PlaybookInterfaceVersion
rn	RN
updatedByUser	TDRUser	非推奨: 使用しないでください
createdByUser	TDRUser

PlaybookInterfaceVersion🔗

説明: PlaybookInterfaceVersionはプレイブックインターフェースの変更履歴を保持します。

フィールド🔗

フィールド	型	説明
id	ID
createdAt	Time
createdBy	String
createdBySubject	Subject
updatedAt	Time
updatedBy	String
updatedBySubject	Subject
name	String
version	SemVer
published	Time
publishedBy	String
publishedBySubject	Subject
interface	PlaybookInterface
title	String
description	String
documentation	String
changeNotes	String
changeNotesMarkdown	String
inputs	JSONSchema
outputs	JSONSchema
updatedByUser	TDRUser	非推奨: 使用しないでください
createdByUser	TDRUser

PlaybookInterfaceVersionPlaybookVersions🔗

説明: PlaybookInterfacePlaybookVersionsは、インターフェースバージョンとそのインターフェースを実装するプレイブックバージョンのマッピングです

フィールド🔗

フィールド	型	説明	引数
interface	PlaybookInterfaceVersion
versions	PlaybookVersion

PlaybookActivityList🔗

説明: PlaybookActivityListは、プレイブックおよびその設定済みアクティビティ、設定可能なアクティビティに関する情報を返すために使用されます。これは、1つのプレイブックインスタンスのみが「簡易化」として指定可能な簡易化プレイブック設定に特化しています。また、プレイブックは1つのインターフェースのみを使用する必要があります。

フィールド🔗

フィールド	型	説明	引数
activities	PlaybookActivity	設定済みまたは設定可能なアクティビティ
instance	PlaybookInstance	すでに設定されている場合のプレイブックインスタンス

PlaybookActivity🔗

説明: PlaybookActivityは、既存の設定済みアクティビティ（PlaybookInterfaceInstance）または設定可能なアクティビティのいずれかを表します。PlaybookInterfaceはmain Playbook.Head.Interfaces[0]で見つかります（1つのみであるべきです）。 PlaybookInterfaceは同じプレイブック内のすべてのエントリで同じです。

フィールド🔗

フィールド	型	説明
playbookInterface	PlaybookInterface	プレイブックインターフェース。同じプレイブック内のすべてのアクティビティで同じです
connection	Connection	アクティビティで既に設定されているコネクション、またはこのプレイブックで利用可能なコネクション。プラットフォームコネクションは省略されます。
connectorVersion	ConnectorVersion	このアクティビティのコネクター要件（ある場合）。複数のコネクター要件は簡易化プレイブックではサポートされず、プラットフォームコネクターは省略されます。
configured	Boolean	trueの場合、これは提供されたインスタンスで既に設定されている既存のアクティビティです
interfaceVersion	PlaybookInterfaceVersion	このインスタンスで設定されているプレイブックインターフェースバージョン。未設定の場合はインターフェースのHEADバージョンとなります。
playbookVersion	PlaybookVersion	このインスタンスで設定されているプレイブックバージョン。未設定の場合はプレイブックのHEADバージョンとなります。ドラフトはサポートされません。

Playbook🔗

説明: Playbookは利用可能なプレイブックのカタログエントリです

フィールド🔗

フィールド	型	説明
id	ID
createdAt	Time
createdBy	String
createdBySubject	Subject
updatedAt	Time
updatedBy	String
updatedBySubject	Subject
name	String
tags	String
icon	String
tenant	String
head	PlaybookVersion
versions	PlaybookVersion
instances	PlaybookInstance
categories	ConnectorCategory
rn	RN
isGlobal	Boolean
simplifiedType	SimplifiedType	プレイブックタイプは、このプレイブックがUIでプレイブックインスタンスの簡易設定に使用できるかどうかを決定します。
title	String
description	String
requires	ConnectorInterface
updatedByUser	TDRUser	非推奨: 使用しないでください
createdByUser	TDRUser

SimplifiedType🔗

説明: SimplifiedTypeはプレイブックの意図された用途を示します。このフィールドはプレイブック設定の簡易化を支援するために使用されます。 None以外の値は通常、簡易化プレイブックUIを使用してプレイブックを設定する際に使用されます。

PlaybookVersion🔗

説明: PlaybookVersionはプレイブック定義の変更履歴を保持します。複数のバージョンのプレイブックが同時に使用される場合があります

フィールド🔗

フィールド	型	説明
id	ID
createdAt	Time
createdBy	String
createdBySubject	Subject
updatedAt	Time
updatedBy	String
updatedBySubject	Subject
name	String
version	SemVer
published	Time
publishedBy	String
publishedBySubject	Subject
playbook	Playbook
instances	PlaybookInstance
title	String
description	String
documentation	String
changeNotes	String
changeNotesMarkdown	String
connectors	ConnectorVersion
playbooks	PlaybookVersion
interfaces	PlaybookInterfaceVersion
triggerHints	PlaybookTriggerHint
inputs	JSONSchema
outputs	JSONSchema
dslSource	String
implements	PlaybookInterfaceVersion
dsl	JSONObject
rn	RN
deprecated	Boolean
deprecationReason	String
updatedByUser	TDRUser	非推奨: 使用しないでください
createdByUser	TDRUser
fastExecute	Boolean

PlaybookVersionStrategy🔗

説明: PlaybookVersionStrategyは新しいバージョンが公開されたときにインスタンスがどのようにアップグレードされるかを決定します

PlaybookInstance🔗

説明: PlaybookInstanceはユーザーアカウント内のプレイブックの設定を定義します

フィールド🔗

フィールド	型	説明
id	ID
createdAt	Time
createdBy	String
createdBySubject	Subject
updatedAt	Time
updatedBy	String
updatedBySubject	Subject
name	String
description	String
tags	String
tenant	String
playbook	Playbook
version	PlaybookVersion
versionStrategy	PlaybookVersionStrategy
trigger	PlaybookTrigger
enabled	Boolean
inputs	JSONObject
retries	PlaybookRetries
connections	Connection
interfaces	PlaybookInterfaceInstance
schedules	PlaybookSchedule
rn	RN
simplified	Boolean	簡易化フラグは、このインスタンスがプレイブック簡易化手順の一部として指定されたプレイブックテンプレートから作成されたことを示します。このタイプのプレイブックごとにテナントあたり1つのプレイブックインスタンスのみ存在できます。値はcreatePlaybookInstanceミューテーションのパラメータで決定されます。
updatedByUser	TDRUser	非推奨: 使用しないでください
createdByUser	TDRUser

PlaybookSchedule🔗

説明: PlaybookScheduleはプレイブックインスタンスのスケジューリングを定義します

フィールド🔗

フィールド	型	説明
id	ID
createdAt	Time
createdBy	String
createdBySubject	Subject
updatedAt	Time
updatedBy	String
updatedBySubject	Subject
name	String
description	String
tenantId	String	プレイブックを所有するテナント。パートナーテナントの場合もあります
playbookInstance	PlaybookInstance	実行するプレイブックインスタンス
cron	String	プレイブックを実行するcron定義
timeZone	String	スケジュールのIANAタイムゾーン。デフォルトはUTC
paused	Boolean	Temporalでスケジュールが一時停止されているかどうかを示します
inputs	JSONObject	プレイブックへの入力
childType	ChildTypeField	パートナーテナントがプレイブックを所有している場合、childTypeは子テナントでの実行方法を示します。デフォルトはNONE
childExpression	String	childTypeがEXPRESSIONの場合、childExpressionは子テナントを決定するCEL式を含みます。例: tenant.services.exists(s, s.name in ['MDR']) tenant.services.exists(s, s.name == 'Taegis Native Agent') tenant.id in ['11772', '35959']
rn	RN	リソース情報
nextRun	Time	次回のスケジュール実行

PlaybookInterfaceInstance🔗

フィールド🔗

フィールド	型	説明	引数
interface	PlaybookInterface
version	PlaybookInterfaceVersion
playbook	PlaybookVersion
connections	Connection

PlaybookRetries🔗

フィールド🔗

フィールド	型	説明	引数
initialInterval	Int
maximumInterval	Int
backoffCoefficient	Float
maximumRetries	Int
maximumDuration	Int
InitialInterval	Int
MaximumInterval	Int
BackoffCoefficient	Float
MaximumRetries	Int
MaximumDuration	Int

Float🔗

説明: Floatスカラ型はIEEE 754で指定された符号付き倍精度浮動小数点値を表します。

PlaybookObject🔗

PlaybookState🔗

PlaybookEvent🔗

説明: PlaybookEventsはワークフロー実行中のトレースイベントを表します

フィールド🔗

フィールド	型	説明	引数
id	Int
object	PlaybookObject
state	PlaybookState
name	String
timestamp	Time
inputs	JSONObject
outputs	Any
reason	String
attempt	Int

PlaybookExecution🔗

説明: PlaybookExecutionは現在のプレイブック実行の状態を表します

このタイプのマルチリゾルビングフェデレーションは、フェデレーションリクエストで提供された最初の10個のIDに制限されています。それ以上の場合、パフォーマンスの問題が発生する可能性があります。

フィールド🔗

フィールド	型	説明
id	ID
createdAt	Time
createdBy	String
createdBySubject	Subject
updatedAt	Time	プラットフォーム作成の実行にはサブジェクトがないため、Subjectは保証されるフィールドではありません - これらはcreatedByフィールドで'anonymous'として表示されます
updatedBy	String
updatedBySubject	Subject
state	PlaybookState	プラットフォーム更新の実行にはサブジェクトがないため、Subjectは保証されるフィールドではありません - これらはupdatedByフィールドで'anonymous'として表示されます
tenant	String
instance	PlaybookInstance
version	PlaybookVersion
inputs	JSONObject
outputs	Any
summary	String
runId	String
events	PlaybookEvent
executionTime	Int
parentExecution	ID
targetResource	String	Target Resourceは、このプレイブック実行がトリガーされたプラットフォームリソースコンテキストを記述します
targetResourceTenant	String	targetResourceが存在するテナント
reason	String	アクションの理由
triggerCategory	String	Trigger Categoryは、その時点でプレイブックを実行するために使用されたトリガーのカテゴリを示します
triggerContext	String	Trigger Contextは、その時点でプレイブックを実行するために使用されたトリガーのコンテキストを示します
rn	RN	リソース情報
type	PlaybookExecutionType	非推奨: 使用しないでください
updatedByUser	TDRUser
createdByEmail	String
createdByUser	TDRUser

PlaybookExecutionType🔗

説明: 非推奨: 使用しないでください

PlaybookExecutions🔗

説明: PlaybookExecutionsは実行リストとページネーションなどの他のメタデータを表します

フィールド🔗

フィールド	型	説明	引数
executions	PlaybookExecution
nodes	PlaybookExecution
totalCount	Int

PlaybookExecutionsV2🔗

フィールド🔗

フィールド	型	説明	引数
totalCount	Int
playbookExecutions	PlaybookExecution
pageInfo	PageInfo

PageInfo🔗

フィールド🔗

フィールド	型	説明	引数
endCursor	String
hasNextPage	Boolean
startCursor	String
hasPreviousPage	Boolean

PlaybookExecutionLog🔗

説明: PlaybookExecutionLogは、実行されたプレイブックからのログエントリであり、その子とステータスログが添付されています

フィールド🔗

フィールド	型	説明	引数
id	ID
taskID	Float
parentID	Float
message	JSONObject
children	Any
statusLogs	Any
createdAt	Time

PlaybookResource🔗

PlaybookQueueStatistics🔗

説明: PlaybookQueueStatisticsはキューに入っているプレイブックに関する情報を含みます

フィールド🔗

フィールド	型	説明	引数
name	String
maxMsgs	Float
maxBytes	Float
msgs	Float
bytes	Float
firstSeq	Float
lastSeq	Float
highMsgs	Float
normalMsgs	Float
executions	ID

PlaybookTriggerHint🔗

フィールド🔗

フィールド	型	説明	引数
isProactiveResponse	Boolean
type	String
config	JSONObject
celHints	PlaybookCelHint

PlaybookCelHint🔗

フィールド🔗

フィールド	型	説明	引数
name	String
expr	String

PlaybooksQLResponse🔗

説明: ConcreteSubjectは基礎となるサブジェクトを表します

PlaybooksQLResult🔗

説明: QL検索クエリで返される可能性のあるオブジェクトタイプ（必要に応じて追加予定）

PlaybooksQLPagination🔗

説明: QLレスポンスのページネーション情報

フィールド🔗

フィールド	型	説明
nextCursor	String	次のページのカーソル（存在しない場合はnull）。結果セットの末尾の場合はnull
previousCursor	String	前のページのカーソル（存在しない場合はnull）。結果セットの先頭の場合はnull
cursor	String	現在のページのカーソル
totalCount	Int	指定した検索条件で利用可能なレコード数

PlaybooksQLSearchResponse🔗

説明: Playbooks QLクエリのレスポンスラッパー

フィールド🔗

フィールド	型	説明	引数
data	PlaybooksQLResult	返されるオブジェクトのリスト。最初はプレイブックインスタンスのみですが、必要に応じて他のもの（例: バージョンを'main'タイプとして）を追加可能
pagination	PlaybooksQLPagination	上記レスポンスのページネーションデータ

PlaybooksQLMapResponse🔗

説明: QLクエリからの集計または非集計のGraphQLモデルレスポンスを表します

フィールド🔗

フィールド	型	説明
fields	String	このレスポンスで返されるフィールドまたはカラム
data	Map	実際のレスポンスデータ。オブジェクト/マップで、フィールドやカラムはクエリで定義されます（集計またはFIELDSによる）
pagination	PlaybooksQLPagination	該当する場合のページネーションデータ。つまり、非構造化レスポンスがFIELDS付きの検索クエリである場合

Mutation🔗

フィールド🔗

フィールド	型	説明	引数
createPlaybook	Playbook	新しいプレイブックを作成	input: CreatePlaybookInput
clonePlaybook	Playbook	既存のプレイブックをクローン	input: ClonePlaybookInput
updatePlaybook	Playbook	プレイブックを更新	input: UpdatePlaybookInput
deletePlaybook	Playbook	プレイブックを削除	input: DeletePlaybookInput
importPlaybookV2	Playbook	ファイルからプレイブックをインポート	input: ImportPlaybookInput
importPlaybookResource	PlaybookResource	ファイルからプレイブックリソースをインポート	input: ImportPlaybookInput
deprecatePlaybook	Playbook	プレイブックを非推奨にする	input: DeprecatePlaybookInput
unDeprecatePlaybook	Playbook	プレイブックの非推奨を解除	input: UndeprecatePlaybookInput
executePlaybook	PlaybookExecution	指定したパラメータでプレイブックを実行	playbookId: ID, parameters: JSONObject, targetResource: String
cancelPlaybookExecution	PlaybookExecution	1つ以上のプレイブック実行をキャンセル	input: CancelPlaybookExecutionInput
reexecutePlaybooks	PlaybookExecution	プレイブックを再実行	input: ReexecutePlaybooksInput
createPlaybookVersion	PlaybookVersion	ドラフトモードで新しいプレイブックバージョンを作成	playbookId: ID, input: CreatePlaybookVersionInput
updatePlaybookVersion	PlaybookVersion	既存のドラフトプレイブックバージョンを更新	input: UpdatePlaybookVersionInput
publishPlaybookVersion	PlaybookVersion	プレイブックバージョンを公開すると不変となり、現在のHEADに設定されます公開済みプレイブックバージョンの削除はサポートされていません	input: PublishPlaybookVersionInput
deletePlaybookVersion	PlaybookVersion	指定したドラフトプレイブックバージョンを削除	input: DeletePlaybookVersionInput
deprecatePlaybookVersion	PlaybookVersion	プレイブックバージョンを非推奨にする	input: DeprecatePlaybookVersionInput
unDeprecatePlaybookVersion	PlaybookVersion	プレイブックバージョンの非推奨を解除	input: UndeprecatePlaybookVersionInput
createPlaybookInstance	PlaybookInstance	新しいプレイブックインスタンスを作成	playbookId: ID, instance: PlaybookInstanceInput
updatePlaybookInstanceV2	PlaybookInstance	プレイブックインスタンスを更新この更新はupdatePlaybookInstanceとは異なり、リクエストに含まれていないフィールドは更新されません。PUTではなくPATCHです	input: UpdatePlaybookInstanceInput
deletePlaybookInstance	PlaybookInstance	プレイブックインスタンスを削除	playbookInstanceId: ID
updateResponseActionPreApproval	PlaybookInstance	テナント内のすべての事前対応アクションの事前承認ステータスを更新します。更新されたプレイブックインスタンスのリストを返します。	input: UpdatePreApprovalInput
createPlaybookExecution	PlaybookExecution	プレイブックトリガー/実行ステータスを記録	input: PlaybookExecutionInput
executePlaybookInstanceV2	PlaybookExecution	プレイブックインスタンスを実行	input: ExecutePlaybookInstanceV2Input
playbookValidate	PlaybookValidationError	プレイブックまたはDSLのみを検証	arguments: PlaybookValidationArguments
createPlaybookInterfaceVersion	PlaybookInterfaceVersion	PlaybookInterfaceVersionを作成	playbookInterfaceId: ID, input: CreatePlaybookInterfaceVersionInput
updatePlaybookInterfaceVersion	PlaybookInterfaceVersion	PlaybookInterfaceVersionを更新	input: UpdatePlaybookInterfaceVersionInput
deletePlaybookInterfaceVersion	PlaybookInterfaceVersion	指定したプレイブックインターフェースバージョンを削除	input: DeletePlaybookInterfaceVersionInput
publishPlaybookInterfaceVersion	PlaybookInterfaceVersion	Playbook Interface Versionを公開	input: PublishPlaybookInterfaceVersionInput
createPlaybookInterface	PlaybookInterface	新しいプレイブックインターフェースを作成	input: CreatePlaybookInterfaceInput
updatePlaybookInterface	PlaybookInterface	プレイブックインターフェースを更新	input: UpdatePlaybookInterfaceInput
deletePlaybookInterface	PlaybookInterface	指定したプレイブックインターフェースを削除	input: DeletePlaybookInterfaceInput
createPlaybookTriggerFilter	PlaybookTriggerFilter	新しいトリガーフィルターを作成	input: CreatePlaybookTriggerFilterInput
updatePlaybookTriggerFilter	PlaybookTriggerFilter	既存のトリガーフィルターを更新	input: UpdatePlaybookTriggerFilterInput
deletePlaybookTriggerFilter	PlaybookTriggerFilter	トリガーフィルターを削除	input: DeletePlaybookTriggerFilterInput
createPlaybookSchedule	PlaybookSchedule	プレイブックスケジュールを作成	input: CreatePlaybookScheduleInput
updatePlaybookSchedule	PlaybookSchedule	プレイブックスケジュールを更新	input: UpdatePlaybookScheduleInput
pausePlaybookSchedule	PlaybookSchedule	プレイブックスケジュールを一時停止	input: PausePlaybookScheduleInput
unpausePlaybookSchedule	PlaybookSchedule	プレイブックスケジュールの一時停止を解除	input: PausePlaybookScheduleInput
deletePlaybookSchedule	PlaybookSchedule	プレイブックスケジュールを削除	input: DeletePlaybookScheduleInput
updatePlaybookInstance	PlaybookInstance		playbookInstanceId: ID, instance: PlaybookInstanceInput
setPlaybookInstanceState	PlaybookInstance		playbookInstanceId: ID, enabled: Boolean
executePlaybookInstance	PlaybookExecution		playbookInstanceId: ID, parameters: JSONObject, targetResource: String
playbookValidateDSL	PlaybookValidationError		arguments: PlaybookValidationArguments

PlaybooksQLInput🔗

説明: Taegis QLクエリ用の入力オブジェクト

フィールド🔗

フィールド	型	説明
ql	String	QL（CQL）クエリ文字列
cursor	String	ページネーション用のオプションカーソル。前回のリクエストから取得します。ページとレコード数を表します
count	Int	指定されており、cursorが指定されていない場合はページサイズとして使用します（それ以外の場合はカーソル内のデータが使用されます）。この値はクエリ内のHEADやTAILを上書きしませんのでご注意ください

ExecutePlaybookInstanceV2Input🔗

フィールド🔗

フィールド	型	説明
playbookInstanceId	ID	実行するプレイブックインスタンスのID
parameters	JSONObject	プレイブックインスタンスに渡すパラメータ（入力値）
targetResource	String	このプレイブック実行がトリガーされたプラットフォームリソースコンテキストを記述します。例: Alert ID, Investigation ID, Event ID, Asset ID, Entity IDなど
targetResourceTenant	String	targetResourceが存在するテナント - プレイブックテナントと異なる場合があります
reason	String	アクションの理由
investigationId	ID	investigationIdは、事前対応アクションをインベスティゲーションに関連付けるために使用されるオプションフィールドです。この実行が事前対応アクションであり、アクションをトリガーするユーザーがSecureworksユーザーである場合のみ設定してください。

CreatePlaybookInput🔗

説明: CreatePlaybookInputはプレイブック作成時に必要または利用可能なフィールドを定義します

フィールド🔗

フィールド	型	説明	引数
name	String
tags	Tags
icon	String
categories	IDs
version	CreatePlaybookVersionInput
simplifiedType	SimplifiedType
isGlobal	Boolean

UpdatePlaybookInput🔗

説明: UpdatePlaybookInputはプレイブックの更新に必要なフィールドおよび更新可能なフィールドを定義します。

フィールド🔗

フィールド	型	説明	引数
playbookId	ID
tags	String
icon	String
categories	IDs
head	ID

ClonePlaybookInput🔗

説明: ClonePlaybookInputはプレイブックをクローンするために必要なフィールドを定義します

フィールド🔗

フィールド	型	説明
name	String	プレイブックの名前。名前にはスペースを含めることはできず、他のプレイブックで参照として使用される場合があります。一度設定すると変更できません。
playbookId	ID	クローンするプレイブックのID 非推奨: もはや必須ではなく、versionIdのみが必要です。
versionId	ID	クローンすべきプレイブックバージョンのID
title	String	プレイブックの表示名を定義するためのオプションフィールド。未設定の場合はnameが表示に使用されます。
isGlobal	Boolean	非推奨: 使用しないでください

DeletePlaybookInput🔗

説明: DeletePlaybookInputはプレイブックを削除するために必要なフィールドを定義します

フィールド🔗

フィールド	型	説明	引数
playbookId	ID

ReexecutePlaybooksInput🔗

フィールド🔗

フィールド	型	説明	引数
executionIDs	ID

ImportPlaybookInput🔗

フィールド🔗

フィールド	型	説明	引数
file	Upload
isGlobal	Boolean

DeprecatePlaybookInput🔗

フィールド🔗

フィールド	型	説明	引数
playbookId	ID
deprecationReason	String

UndeprecatePlaybookInput🔗

フィールド🔗

フィールド	型	説明	引数
playbookId	ID

DeprecatePlaybookVersionInput🔗

フィールド🔗

フィールド	型	説明	引数
playbookVersionId	ID
deprecationReason	String

UndeprecatePlaybookVersionInput🔗

フィールド🔗

フィールド	型	説明	引数
playbookVersionId	ID

CreatePlaybookVersionInput🔗

説明: CreatePlaybookVersionInputはプレイブックバージョン作成時に使用されるフィールドを定義します

フィールド🔗

フィールド	型	説明	引数
title	String
description	String
documentation	String
changeNotes	String
changeNotesMarkdown	String
connectors	IDs
playbooks	IDs
triggerHints	PlaybookTriggerHintInput
inputs	JSONSchema
outputs	JSONSchema
dsl	YAMLObject
version	SemVer
implements	ID
interfaces	IDs
requires	IDs
fastExecute	Boolean

UpdatePlaybookVersionInput🔗

説明: UpdatePlaybookVersionInputはプレイブックバージョンの更新可能なフィールドを定義します

フィールド🔗

フィールド	型	説明	引数
playbookVersionId	ID
title	String
description	String
documentation	String
changeNotes	String
changeNotesMarkdown	String
connectors	IDs
playbooks	IDs
triggerHints	PlaybookTriggerHintInput
inputs	JSONSchema
outputs	JSONSchema
dsl	YAMLObject
version	SemVer
implements	ID
interfaces	IDs
requires	IDs
fastExecute	Boolean

PublishPlaybookVersionInput🔗

説明: PublishPlaybookVersionInputはプレイブックバージョンを公開するために必要なフィールドを定義します

フィールド🔗

フィールド	型	説明	引数
playbookVersionId	ID
version	SemVer

DeletePlaybookVersionInput🔗

説明: DeletePlaybookVersionInputはプレイブックバージョンを削除するために必要なフィールドを定義します

フィールド🔗

フィールド	型	説明	引数
playbookVersionId	ID

PlaybookInstanceInput🔗

説明: PlaybookInstanceInputはプレイブックインスタンスの更新可能なフィールドを定義します

フィールド🔗

フィールド	型	説明
name	String
description	String
tags	Tags
versionStrategy	PlaybookVersionStrategy	プレイブックが更新または新しいバージョンが公開されたときに従うべき戦略。このフィールドは必須として扱うべきです（今後のAPIバージョンでは必須となります）が、未指定の場合はFollowMajorVersionまたはインスタンスの既存戦略がデフォルトとなります。
fixedVersion	ID
version	ID	インスタンスが使用すべきプレイブックバージョン。未指定の場合はプレイブックの現在のHEADバージョンがデフォルトとなります。 versionStrategyがfixedの場合、バージョンは自動更新されません。それ以外の戦略では、新しいプレイブックが公開されたときに選択した戦略に基づいて自動更新されます。
trigger	PlaybookTriggerInput
enabled	Boolean
inputs	JSONObject
connections	IDs
interfaces	PlaybookInterfaceInstanceInput
simplified	Boolean	簡易化フラグは、UIからプレイブックインスタンスが簡易UIで作成されていることを示します。これにより、簡易設定用の各プレイブックにつき1つのプレイブックインスタンスのみが作成されることが保証されます。このフラグはcreate時のみ使用され、デフォルトはFalseです。

UpdatePlaybookInstanceInput🔗

フィールド🔗

フィールド	型	説明
playbookInstanceId	ID
name	String
description	String
tags	Tags
versionStrategy	PlaybookVersionStrategy	プレイブックが更新または新しいバージョンが公開されたときに従うべき戦略。このフィールドは必須として扱うべきです（今後のAPIバージョンでは必須となります）が、未指定の場合はFollowMajorVersionまたはインスタンスの既存戦略がデフォルトとなります。
version	ID	インスタンスが使用すべきプレイブックバージョン。未指定の場合はプレイブックの現在のHEADバージョンがデフォルトとなります。 versionStrategyがfixedの場合、バージョンは自動更新されません。それ以外の戦略では、新しいプレイブックが公開されたときに選択した戦略に基づいて自動更新されます。
trigger	UpdatePlaybookTriggerInput
enabled	Boolean
inputs	JSONObject
connections	IDs
interfaces	PlaybookInterfaceInstanceInput

PlaybookTriggerHintInput🔗

フィールド🔗

フィールド	型	説明	引数
isProactiveResponse	Boolean
type	String
config	JSONObject

PlaybookTriggerInput🔗

フィールド🔗

フィールド	型	説明	引数
name	String
description	String
tags	Tags
typeId	ID
config	JSONObject
isPreApproved	Boolean

UpdatePlaybookTriggerInput🔗

フィールド🔗

フィールド	型	説明	引数
name	String
description	String
tags	Tags
typeId	ID
config	JSONObject
isPreApproved	Boolean

PlaybookInterfaceInstanceInput🔗

フィールド🔗

フィールド	型	説明	引数
interface	ID
version	ID
playbook	ID
connections	IDs

PlaybookExecutionLogLevel🔗

PlaybookExecutionLogInput🔗

説明: PlaybookExecutionLogInputは記録するログを定義します

フィールド🔗

フィールド	型	説明	引数
level	PlaybookExecutionLogLevel
message	String
fields	JSONObject
error	String

PlaybookExecutionInput🔗

説明: PlaybookExecutionInputは、外部トリガーがフィルター条件評価エラーを記録するためにプレイブック実行を作成できるようにします

フィールド🔗

フィールド	型	説明	引数
playbookInstanceId	ID
state	PlaybookState
inputs	JSONObject
logs	PlaybookExecutionLogInput
targetResource	String
targetResourceTenant	String

Pagination🔗

説明: Paginationは特定のページや1ページあたりの結果数をリクエストするためのオプションを定義します

フィールド🔗

フィールド	型	説明	引数
page	Int
perPage	Int

CreatePlaybookInterfaceVersionInput🔗

説明: CreatePlaybookInterfaceVersionInputはプレイブックインターフェースバージョン作成時に使用されるフィールドを定義します

フィールド🔗

フィールド	型	説明	引数
title	String
description	String
documentation	String
changeNotes	String
changeNotesMarkdown	String
inputs	JSONSchema
outputs	JSONSchema
version	SemVer

UpdatePlaybookInterfaceVersionInput🔗

説明: UpdatePlaybookInterfaceVersionInputはプレイブックインターフェースバージョンの更新に使用されるフィールドを定義します

フィールド🔗

フィールド	型	説明	引数
interfaceVersionId	ID
title	String
description	String
documentation	String
changeNotes	String
changeNotesMarkdown	String
inputs	JSONSchema
outputs	JSONSchema
version	SemVer

DeletePlaybookInterfaceVersionInput🔗

説明: DeletePlaybookInterfaceVersionInputはプレイブックインターフェースバージョンを削除するために必要なフィールドを定義します

フィールド🔗

フィールド	型	説明	引数
playbookInterfaceVersionId	ID

PublishPlaybookInterfaceVersionInput🔗

説明: PublishPlaybookInterfaceVersionInputはプレイブックインターフェースバージョンを公開するために必要なフィールドを定義します

フィールド🔗

フィールド	型	説明	引数
playbookInterfaceVersionId	ID
version	SemVer

CreatePlaybookInterfaceInput🔗

説明: CreatePlaybookInterfaceInputはプレイブックインターフェース作成に必要なフィールドを定義します

フィールド🔗

フィールド	型	説明	引数
name	String
tags	String
icon	String
version	CreatePlaybookInterfaceVersionInput

UpdatePlaybookInterfaceInput🔗

説明: UpdatePlaybookInterfaceInputはプレイブックインターフェースの更新に必要なフィールドを定義します

フィールド🔗

フィールド	型	説明	引数
interfaceId	ID
tags	String
icon	String
head	ID

DeletePlaybookInterfaceInput🔗

説明: DeletePlaybookInterfaceInputはプレイブックインターフェースの削除に必要なフィールドを定義します

フィールド🔗

フィールド	型	説明	引数
playbookInterfaceId	ID

QueryOptions🔗

説明: QueryOptionsはデフォルトのクエリ動作を上書きする機能を提供します

フィールド🔗

フィールド	型	説明
timestampAscending	Boolean	デフォルトのタイムスタンプ順（降順）を逆にします
maxRows	Int
timestampField	String

PlaybookStatistics🔗

説明: プレイブック統計情報

フィールド🔗

フィールド	型	説明	引数
table	String
columns	String
rows	Any

CancelPlaybookExecutionInput🔗

説明: プレイブック実行のキャンセル

フィールド🔗

フィールド	型	説明	引数
executionIDs	ID
instanceIDs	ID
startTime	Time
endTime	Time
clearQueue	Boolean
cancelExecutions	Boolean
reason	String
global	Boolean
query	String
skipAuditLogs	Boolean

CreatePlaybookTriggerFilterInput🔗

説明: プレイブックトリガーの作成

フィールド🔗

フィールド	型	説明	引数
name	String
description	String
config	JSONObject
ruleId	ID

UpdatePlaybookTriggerFilterInput🔗

フィールド🔗

フィールド	型	説明	引数
id	ID
name	String
description	String
config	JSONObject
ruleId	String

DeletePlaybookTriggerFilterInput🔗

フィールド🔗

フィールド	型	説明	引数
id	ID

PlaybookScheduleArguments🔗

説明: PlaybookScheduleArgumentsはプレイブックスケジュールを取得するためのパラメータを含みます

フィールド🔗

フィールド	型	説明	引数
scheduleId	ID

PlaybookSchedulesArguments🔗

説明: PlaybookSchedulesArgumentsはプレイブックスケジュールのセットを一覧取得するためのクエリパラメータを保持します

フィールド🔗

フィールド	型	説明	引数
playbookInstanceId	ID
sortBy	ScheduleSortField
orderBy	PaginationOrder
page	Int
perPage	Int

ScheduleSortField🔗

説明: InstanceSortFiledはプレイブックスケジュールのリストを取得する際のソート順を決定します。ソートフィールドが指定されていない場合、リストはNAMEでソートされます。

PlaybookSchedulesResults🔗

説明: PlaybookSchedulesResultsはプレイブックスケジュール検索の結果として返されるプレイブックスケジュールのリストを含みます

フィールド🔗

フィールド	型	説明	引数
results	PlaybookSchedule
count	Int

CreatePlaybookScheduleInput🔗

説明: CreatePlaybookScheduleInputは新しいプレイブックスケジュールを作成するためのパラメータを含みます

フィールド🔗

フィールド	型	説明
name	String	プレイブックスケジュールの名前
description	String	プレイブックスケジュールの説明
playbookInstance	ID	スケジュールがトリガーされたときに実行するプレイブックインスタンス
cron	String	スケジュールのcron定義
timeZone	String	スケジュールのIANAタイムゾーン。デフォルトはUTC
paused	Boolean	スケジュールが現在一時停止されていることを示します
inputs	JSONObject	プレイブック実行の入力
childType	ChildTypeField	プレイブック実行が指定テナントまたは子テナントで行われるかどうかを示します
childExpression	String	childTypeがEXPRESSIONの場合に子テナントを検索するための式

UpdatePlaybookScheduleInput🔗

説明: UpdatePlaybookScheduleInputは既存のプレイブックスケジュールを更新するためのパラメータを含みます

フィールド🔗

フィールド	型	説明
id	ID	スケジュールID
name	String	プレイブックスケジュールの名前
description	String	プレイブックスケジュールの説明
playbookInstance	ID	スケジュールがトリガーされたときに実行するプレイブックインスタンス
cron	String	スケジュールのcron定義
timeZone	String	スケジュールのIANAタイムゾーン。デフォルトはUTC。cron文字列が指定されている場合は必須。それ以外は無視されます。
inputs	JSONObject	プレイブック実行の入力
childType	ChildTypeField	プレイブック実行が指定テナントまたは子テナントで行われるかどうかを示します
childExpression	String	childTypeがEXPRESSIONの場合に子テナントを検索するための式

ChildTypeField🔗

説明: ChildTypeFieldは、プレイブックを子テナントでスケジューリング実行する際に許可されるタイプを定義します。テナントがパートナーテナントでない場合、NONEのみが可能です。

PausePlaybookScheduleInput🔗

説明: PausePlaybookScheduleInputはプレイブックスケジュールを一時停止または解除するためのパラメータを含みます

フィールド🔗

フィールド	型	説明	引数
scheduleId	ID	スケジュールID
reason	String	スケジュールの一時停止または解除の理由

DeletePlaybookScheduleInput🔗

説明: DeletePlaybookScheduleInputはプレイブックスケジュールを削除するためのパラメータを含みます

フィールド🔗

フィールド	型	説明	引数
scheduleId	ID	スケジュールID

Subscription🔗

フィールド🔗

フィールド	型	説明	引数
playbookExecutionUpdates	PlaybookExecution		arguments: PlaybookExecutionUpdatesArguments

PlaybookExecutionUpdatesArguments🔗

フィールド🔗

フィールド	型	説明	引数
playbookExecutionIds	ID

ReconcileInstanceVersionsArguments🔗

フィールド🔗

フィールド	型	説明	引数
playbookInstanceId	ID
playbookVersionId	ID

UpdatePreApprovalInput🔗

説明: UpdatePreApprovalInputは、テナントのすべての事前対応アクションの事前承認ステータスを更新するためのパラメータを含みます。テナントはX-Tenant-Contextヘッダーで識別されます。'simplified'として指定されたすべての事前対応アクションのisPreApprovedフラグが'approved'値にリセットされます。

フィールド🔗

フィールド	型	説明	引数
approved	Boolean	approvedは事前承認ステータスを有効または無効にするかどうかを示します。'true'オプションは現在サポートされていません。デフォルトは'false'です