スクリプトAPI

概要：スクリプトのXMLを名前またはmasterIdで返します。

説明：この方法は、名前またはmasterIdによってスクリプトのXMLを返します。

パラメーター：

-名前：scriptPath

in：パス

説明：スクリプトの完全パス

必須：真

スタイル：シンプル

爆発：偽

スキーマ：

タイプ：文字列

-名前：scriptId

in：パス

説明：スクリプトのマスターID

必須：真

スタイル：シンプル

爆発：偽

スキーマ：

タイプ：整数

反応：

'200'：

説明：成功

コンテンツ：

application/json:

スキーマ：

タイプ：オブジェクト

プロパティ：

名前：

タイプ：文字列

説明：スクリプトの名前

filePath:

タイプ：文字列

説明：ファイルパス

ScriptId：

タイプ：整数

説明：MasterId

ボディ：

タイプ：文字列

説明：スクリプトのXML

'400'：説明：無効なパラメーター

'404'：説明：見つかりません

'500'：説明：内部エラー

'501'：説明：Incontrol.Netサービスの内部エラー

概要：新しいスクリプトまたは既存のスクリプトを保存します。

説明：この方法は、base64文字列を使用してスクリプトをDBに保存します。

パラメーター：

-名前：scriptPath

in：パス

説明：フルパスとスクリプトの名前

必須：真

スタイル：シンプル

爆発：偽

スキーマ：

タイプ：文字列

-名前：ボディ

in：パス

説明： 「スクリプトのボディ。これはbase64でエンコードされたXMLです」

必須：真

スタイル：シンプル

爆発：偽

スキーマ：

タイプ：文字列

反応：

'200'：

説明：成功

コンテンツ：

application/json:

スキーマ：

SaveScript：

タイプ：オブジェクト

プロパティ：

ScriptId：

タイプ：文字列

説明：保存が成功した後に生成された新しいScriptId

'400'：説明：無効なパラメーター

'405'：説明：他の誰かによってロックされています

'500'：説明：内部エラー

'501'：説明：サービスの内部エラー

概要：新しいスクリプトまたは既存のスクリプトを保存します。

説明：この方法は、base64文字列を使用してスクリプトをDBに保存します。

パラメーター：

-名前：scriptPath

in：パス

説明：フルパスとスクリプトの名前

必須：真

スタイル：シンプル

爆発：偽

スキーマ：

タイプ：文字列

-名前：ボディ

in：パス

説明： 「スクリプトのボディ。これはbase64でエンコードされたXMLです」

必須：真

スタイル：シンプル

爆発：偽

スキーマ：

タイプ：文字列

反応：

'200'：

説明：成功

コンテンツ：

application/json:

スキーマ：

タイプ：オブジェクト

プロパティ：

ScriptId：

タイプ：文字列

説明：保存が成功した後に生成された新しいScriptId

'400'：説明：無効なパラメーター

'405'：説明：他の誰かによってロックされています

'500'：説明：内部エラー

'501'：説明：サービスの内部エラー

概要：ロックされたスクリプトをキックします。

説明：このメソッドは、スクリプトのロックを強制的に解除します。

パラメーター：

-名前：scriptPath

in：パス

説明：スクリプトの完全パス

必須：真

スタイル：シンプル

爆発：偽

スキーマ：

タイプ：文字列

反応：

'200'：説明：成功

タイプ：オブジェクト

プロパティ：

タイプ：文字列

説明：リクエスト日

エラーメッセージ：

タイプ：文字列

説明：サービスからのエラーメッセージ

ErrorState：

タイプ：ブーリアン

説明：エラー状態

KickResult：

タイプ：文字列

説明：サービスの結果

MasterID:

タイプ：整数

説明：スクリプトのマスターID

CurrLockedBy：

タイプ：整数

説明：キックされたユーザーのID

'400'：説明：無効なパラメーター、既にロック解除されているスクリプト、スクリプトから自分をキックすることはできません

'404'：説明：ScriptNotFound

'500'：説明：内部エラー

'501'：説明：サービスの内部エラー

概要：スクリプトの履歴を返します。

説明：この方法は、スクリプトの履歴を名前で返します。

パラメーター：

-名前：scriptPath

in：パス

説明：スクリプトの完全パス

必須：真

スタイル：シンプル

爆発：偽

スキーマ：

タイプ：文字列

反応：

'200'：

説明：成功

コンテンツ：

application/json:

スキーマ：

HistoryScripts：

タイプ：オブジェクト

プロパティ：

名前：

タイプ：文字列

説明：名前で結合されたスクリプトの完全パス

バージョン：

タイプ：配列

アイテム：

HistoryScripts_versions：

タイプ：オブジェクト

プロパティ：

scriptId：

タイプ：整数

説明：スクリプトのマスターID

modifyDate：

タイプ：文字列

説明：日付変更

modifyUser：

タイプ：文字列

説明：ユーザー変更

ステータス：

タイプ：文字列

説明：スクリプトのステータス

'400'：説明：無効なパラメーター

'404'：説明：見つかりません

'500'：説明：内部エラー

'501'：説明：Incontrol.Netサービスの内部エラー

取得：

タグ：

概要：検索スクリプト

説明：この方法は、キーワードに基づいて事業単位内のスクリプトを検索します。

パラメーター：

名前：mediaType

in：クエリ

説明：スクリプトのメディアタイプ。

必須：偽

爆発：偽

スキーマ：

タイプ：整数

名前：scriptName

in：パス

説明：検索用のキーワード

必須：真

スタイル：シンプル

爆発：偽

スキーマ：

タイプ：文字列

名前：includeInactive

in：クエリ

説明：この変数は、非アクティブなスクリプト間の検索を含めるために使用されます。

必須：偽

爆発：偽

スキーマ：

タイプ：ブーリアン

名前：includeTrusted

in：クエリ

説明：この変数は、信頼できる事業単位間の検索を含めるために使用されます

必須：偽

爆発：偽

スキーマ：

タイプ：文字列

名前：modEndDate

in：クエリ

説明：この変数は、確立された日付範囲に検索を含めるために使用されます

必須：偽

爆発：偽

スキーマ：

タイプ：文字列

反応：

'200'：

説明：成功

コンテンツ：

application/json:

スキーマ：

$ref: 「#/components/schemasSearchScript」

'400'：

説明：無効なパラメーター

'401'：

説明：無許可。十分な権限がありません

'404'：

説明：スクリプトパスが見つかりません

'500'：

説明：内部エラー

'501':

説明：Incontrol.Netサービスの内部エラー

コンポーネント：

スキーマ：

GetScript：

タイプ：オブジェクト

プロパティ：

名前：

タイプ：文字列

説明： 「スクリプトの名前」

filePath:

タイプ：文字列

説明： 「フルスクリプトパス」

scriptId：

タイプ：整数

説明：「これはスクリプト識別子であり、一意です」

ボディ：

タイプ：文字列

説明：「Base63形式でエンコードされたスクリプトコンテンツ」

DeleteScript：

タイプ：オブジェクト

プロパティ：

scriptPath：

タイプ：文字列

説明：「削除されたフルパススクリプト名の情報」

削除済み：

タイプ：ブーリアン

説明： 「スクリプトのステータス」

エラー：

タイプ：文字列

説明：「削除プロセスでエラーが発生した場合」

SearchScript：

タイプ：オブジェクト

プロパティ：

タイプ：整数

説明：「事業単位の情報」

scriptName：

タイプ：文字列

説明： 「フルスクリプトパス」

scriptSearchDetails：

タイプ：配列

説明：「検索結果の詳細」

アイテム：

$ref: 「#/components/schemasSearchScript」

SearchScript_Details：

タイプ：オブジェクト

プロパティ：

busNo:

タイプ：整数

説明：「事業単位番号」

masterID：

タイプ：文字列

説明： 「スクリプト識別子」

scriptName：

タイプ：文字列

説明： 「スクリプトの名前」

ステータス：

タイプ：文字列

説明： 「スクリプトのアクティブ/非アクティブのステータス」

mediaType:

タイプ：整数

説明：「メディアタイプ番号」

modifyDate：

タイプ：文字列

説明： 「最終変更日」

mUser：

タイプ：整数

説明： 「スクリプトを変更した最後のユーザー」

actionID：

タイプ：整数

説明： 「アクション識別子」