GoFileRoom

GoFileRoom は、クラウドベースのドキュメント管理およびワークフロー ソリューションです。 GoFileRoom コネクタを使用すると、ドキュメント、ユーザー管理、および FirmFlow アクションを実行できます。

このコネクタは、次の製品および地域で利用可能です。

Service	クラス	地域
Logic Apps	標準	以下を除くすべての Logic Apps 地域 :      -   Azure 政府の地域      -   Azure China の地域      -   米国国防総省 (DoD)
Power Automate	Standard	以下を除くすべての Power Automate 地域 :      -   米国政府 (GCC)      -   米国政府 (GCC High)      -   21 Vianet が運用する中国のクラウド      -   米国国防総省 (DoD)
Power Apps	標準	以下を除くすべての Power Apps 地域 :      -   米国政府 (GCC)      -   米国政府 (GCC High)      -   21Vianet が運用する中国のクラウド      -   米国国防総省 (DoD)

お問い合わせ先
件名	GoFileRoom サポート
[URL]	https://tax.thomsonreuters.com/us/en/cs-professional-suite/support/contact
メール	CS.Support@ThomsonReuters.com

Connector Metadata
発行者	Thomson Reuters
Web サイト	https://www.gofileroom.com/
プライバシー ポリシー	https://www.thomsonreuters.com/en/privacy-statement.html
カテゴリ	データ; ビジネス管理

GoFileRoom コネクタは、トムソン・ロイターの顧客が GoFileRoom および FirmFlow の API を利用するための簡単な方法を提供します。 ユーザーは、ユーザー管理、ドキュメント、または FirmFlow に関連する自動化と統合を作成できます。

前提条件

コネクタを使用するには、ユーザーは GoFileRoom API キーを持っている必要があります。

資格情報の入手方法

API キーは、https://developerportal.thomsonreuters.com/ でアカウントを登録することで取得できます。 さらに、アクティブな GoFileRoom アカウントが必要です。 GoFileRoom に興味がある場合は、こちらからお問い合わせください: https://tax.thomsonreuters.com/us/en/cs-professional-suite/gofileroom#contact

接続の作成

コネクタは、次の認証タイプをサポートしています:

既定	接続を作成するためのパラメーター。	すべての地域	共有不可

既定

適用できるもの: すべての領域

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

件名	タイプ	内容	必要
X-TR-API-APP-ID	securestring	この API の X-TR-API-APP-ID	True

調整制限

名前	呼び出し	更新期間
接続ごとの API 呼び出し	100	60 秒

アクション

LookupList 値を取得	LookupList から値を取得
PDF の結合	PDF ファイルを統合
Taxsort ドキュメント	Taxsort PDF ドキュメント
アップロードの場所を取得	ユーザーのアップロードの場所を取得
インデックス LookupList 検索	このメソッドは、オートコンプリート フィールドで使用するように設計されています。
インデックスの動的ルールを取得	指定されたインデックス用に構成された動的ルールのリストを取得
インデックスの検証	提供されたインデックスが有効かどうかを確認します。
インデックス値のリストを取得	リスト タイプ インデックスのすべてのエントリを取得
グループ ドキュメント セキュリティを取得	グループ ドキュメント セキュリティを取得
グループ ドキュメント セキュリティを設定	ドキュメント セキュリティをグループに割り当てます
グループのアクセス許可の取得	グループのアクセス許可を取得
グループのアクセス許可の設定	グループにアクセス許可を割り当てます
グループの取得	ユーザーおよびグループの管理に使用できるグループを取得
グループの変更	グループのアクセス許可の変更
グループを作成	アクセス許可グループを作成
トークンの検証	トークンのステータスを検証
ドキュメント インデックスの取得	ドキュメントのインデックスを取得
ドキュメント ステータスの公開	ClientFlow からドキュメントを公開または非公開にします。
ドキュメント 再インデックス	ドキュメントのインデックスを再作成
ドキュメントの作成	インデックス付きのドキュメント レコードを作成
ドキュメントの履歴を取得	ドキュメントの履歴を取得
ドキュメントの検索	ユーザーがアクセスできるすべてのドキュメントを指定されたドロワーにロードします。
ドキュメントの状態を取得	ドキュメントの状態を取得
ドキュメントをコピー	ドキュメントをコピー
ドキュメントを削除する	ドキュメントを削除
ドキュメントを取得	ドキュメントをダウンロード
ドロワー インデックスを取得	ドロワーに設定されているドキュメント インデックスのリストを取得
ドロワーを取得	ログインしたユーザーがアクセスできるドロワーを取得
パスワード ポリシーの取得	会社のパスワード ポリシーを取得
マスター成果物を削除	マスター成果物を削除
マスター成果物を取得する	マスター成果物を取得する
マスター成果物を編集	マスター成果物を編集
マスター成果物を追加	マスター成果物を追加
ユーザー ドキュメント セキュリティを取得	ログインごとにユーザー ドキュメントのセキュリティを取得
ユーザー ドキュメント セキュリティを設定	ユーザーのドキュメント セキュリティのアクセス許可を割り当てます
ユーザーのアクセス許可を取得	ユーザーのアクセス許可を取得
ユーザーのアクセス許可を設定	ユーザーにアクセス許可を割り当てます
ユーザーの作成	GoFileRoom および ClientFlow ユーザーをシステムに作成
ユーザーの取得	ログインしたユーザーの GFR ユーザーを取得
ユーザーを削除	GoFileRoom および ClientFlow ユーザーをシステムから削除
ユーザーを変更	ユーザーのアクセス許可の変更
ユーザー情報の取得 V2	ユーザー名を取得
ユーザー情報を取得	GFR ユーザー情報を取得
ライセンスを取得	ライセンス数を取得
レポートのリストを取得	ユーザー管理に使用できるレポートを取得
ログアウト	アプリケーションのログアウト
ログイン	ユーザーをアプリケーションにログイン
ワークフロー V2 をルーティング	ワークフロー V2 をルーティング
ワークフローを作成	ワークフローを作成
ワークフローを削除	ワークフローを削除
ワークフローを編集	ワークフローを編集
子インデックスを取得	親リスト値が選択されたときに提供されるリスト ID に基づいて、子インデックス値のリストを取得します。
追跡レポート (ワークフロー別)	追跡レポート (ワークフロー別)
追跡レポート (成果物別) V2	追跡レポート (成果物別) V2
配送可能な FirmFlow データの取得	配送可能データによる追跡レポートを取得

LookupList 値を取得

操作 ID:

GetLookupList

LookupList から値を取得

パラメーター

名前	キー	必須	型	説明
ドロワー ID。 クライアント ドロワーの例: 「0000000001」	drawerId	True	string	ドロワー ID を入力
トークン	X-Authorization		string	トークン認証

戻り値

名前	パス	型	説明
		array of object
clientName	clientName	string	クライアント名の値
clientNumber	clientNumber	string	クライアント番号の値

PDF の結合

操作 ID:

MergePDF

PDF ファイルを統合

パラメーター

名前	キー	必須	型	説明
Token	X-Authorization		string	トークン認証
body	body		array of string

戻り値

返答

string

Taxsort ドキュメント

操作 ID:

TaxsortDocument

Taxsort PDF ドキュメント

パラメーター

名前	キー	必須	型	説明
Token	X-Authorization		string	トークン認証
body	body		array of string

戻り値

名前	パス	型	説明
		array of object
documentId	documentId	string	ドキュメント ID の値
isTaxSorted	isTaxSorted	boolean	TaxSorted 処理がされたドキュメントである
taxsortDocumentException	taxsortDocumentException	string	taxsort ドキュメントの例外

アップロードの場所を取得

操作 ID:

GetUploadLocation

ユーザーのアップロードの場所を取得

パラメーター

名前	キー	必須	型	説明
トークン	X-Authorization		string	トークン認証

戻り値

名前	パス	型	説明
uploadLocations	uploadLocations	array of object	uploadLocations
locationName	uploadLocations.locationName	string	場所名の値
locationPath	uploadLocations.locationPath	string	場所のパス値
uploadLocationsException	uploadLocationsException	string	場所の例外をアップロード

インデックス LookupList 検索

操作 ID:

IndexLookupListFind

このメソッドは、オートコンプリート フィールドで使用するように設計されています。

パラメーター

名前	キー	必須	型	説明
IndexID	indexId	True	string	インデックス ID を入力
トークン	X-Authorization		string	トークン認証
ActionType	ActionType		integer	アクション タイプの入力
カウント	Count		integer	数字の入力
IndexValue	IndexValue		string	インデックス値の入力
SearchType	SearchType		integer	検索タイプの入力

戻り値

名前	パス	型	説明
		array of object
indexId	index.indexId	string	インデックス ID 値
indexValue	index.indexValue	string	インデックス値
linkedIndexes	linkedIndexes	array of object	linkedIndexes
indexId	linkedIndexes.indexId	string	indexId
indexValue	linkedIndexes.indexValue	string	indexValue

インデックスの動的ルールを取得

操作 ID:

GetDynamicRulesForIndex

指定されたインデックス用に構成された動的ルールのリストを取得

パラメーター

名前	キー	必須	型	説明
IndexId	indexId	True	string	インデックス ID を入力
トークン	X-Authorization		string	トークン認証

戻り値

名前	パス	型	説明
		array of object
条件	condition	string	条件の値
dependentIndexId	dependentIndexId	string	依存インデックス ID 値
dynamicRuleId	dynamicRuleId	string	動的ルール ID 値
値	value	string	値

インデックスの検証

操作 ID:

ValidateIndexes

提供されたインデックスが有効かどうかを確認します。

パラメーター

名前	キー	必須	型	説明
トークン	X-Authorization		string	トークン認証
DrawerId	DrawerId		string	ドロワー ID を入力
IndexId	IndexId		string	インデックス ID を入力
IndexValue	IndexValue		string	インデックス値の入力

戻り値

名前	パス	型	説明
errorMessage	errorMessage	string	エラー メッセージ
エラー	errors	array of	エラー
isValid	isValid	boolean	インデックスは有効です

インデックス値のリストを取得

操作 ID:

GetListTypeIndexData

リスト タイプ インデックスのすべてのエントリを取得

パラメーター

名前	キー	必須	型	説明
IndexId	indexId	True	string	インデックス ID を入力
トークン	X-Authorization		string	トークン認証

戻り値

名前	パス	型	説明
		array of object
childIndexId	childIndexId	string	子インデックス ID 値
childListId	childListId	integer	子リスト ID 値
hasChildren	hasChildren	boolean	インデックスには子インデックスがありますか
listEntryId	listEntryId	integer	入力 ID 値のリスト
listId	listId	integer	ID 値のリスト
値	value	string	値

グループ ドキュメント セキュリティを取得

操作 ID:

GetGroupDocumentSecurity

グループ ドキュメント セキュリティを取得

パラメーター

名前	キー	必須	型	説明
GroupName	groupName	True	string	グループ名を入力
CabinetName	cabinetName	True	string	キャビネット名を入力
DrawerName	drawerName	True	string	ドロワー名を入力
Token	X-Authorization		string	トークン認証

戻り値

名前	パス	型	説明
グループ名	groupName	string	グループ名
キャビネット名	cabinetName	string	キャビネット名
ドロワー名	drawerName	string	ドロワー名
documentSecurity	documentSecurity	array of object	documentSecurity
インデックス名	documentSecurity.indexName	string	インデックス名
ドキュメント セキュリティの種類	documentSecurity.docSecurityType	string	ドキュメント セキュリティの種類
values	documentSecurity.values	array of string	values
グループ ドキュメント セキュリティの例外	getGroupDocSecurityException	string	グループ ドキュメント セキュリティの例外

グループ ドキュメント セキュリティを設定

操作 ID:

SetGroupDocSecurity

ドキュメント セキュリティをグループに割り当てます

パラメーター

名前	キー	必須	型	説明
トークン	X-Authorization		string	トークン認証
CabinetName	CabinetName		string	キャビネット名を入力
DocSecurityType	DocSecurityType		string	ドキュメント セキュリティ タイプを入力
IndexName	IndexName		string	インデックス名を入力
オペレーション	Operation		string	オペレーション タイプの入力
Values	Values		array of string	Values
DrawerName	DrawerName		string	ドロワーを入力
GroupName	GroupName		string	グループ名を入力

戻り値

名前	パス	型	説明
groupName	groupName	string	グループ名の値
isSetGroupDocSecurity	isSetGroupDocSecurity	boolean	ドキュメント セキュリティを設定しましたか
setGroupDocSecurityException	setGroupDocSecurityException	string	グループ ドキュメント セキュリティの例外

グループのアクセス許可の取得

操作 ID:

GetGroupPermissions

グループのアクセス許可を取得

パラメーター

名前	キー	必須	型	説明
GroupName	groupName		string	グループ名を入力
トークン	X-Authorization		string	トークン認証

戻り値

名前	パス	型	説明
キャビネット	cabinet	string	キャビネット名
追加	cabinetPermissions.add	boolean	アクセス許可を追加
削除	cabinetPermissions.delete	boolean	アクセス許可を削除
拒否	cabinetPermissions.deny	boolean	アクセス許可を拒否
編集	cabinetPermissions.edit	boolean	アクセス許可の編集
lookUp	cabinetPermissions.lookUp	boolean	アクセス許可のルックアップ
読み込み	cabinetPermissions.read	boolean	アクセス許可の読み取り
drawerPermissions	drawerPermissions	array of object	drawerPermissions
ドロワー	drawerPermissions.drawer	string	ドロワー名
追加	drawerPermissions.permission.add	boolean	アクセス許可を追加
削除	drawerPermissions.permission.delete	boolean	アクセス許可を削除
拒否	drawerPermissions.permission.deny	boolean	アクセス許可を拒否
編集	drawerPermissions.permission.edit	boolean	アクセス許可の編集
検索	drawerPermissions.permission.lookUp	boolean	アクセス許可の検索
読み込み	drawerPermissions.permission.read	boolean	アクセス許可の読み取り
groupName	groupName	string	グループ名
groupPermissionException	groupPermissionException	string	グループのアクセス許可の例外

グループのアクセス許可の設定

操作 ID:

SetGroupPermissions

グループにアクセス許可を割り当てます

パラメーター

名前	キー	必須	型	説明
トークン	X-Authorization		string	トークン認証
キャビネット	Cabinet		string	キャビネット名を入力
加算	Add		string	true または false を指定
Delete キー	Delete		string	true または false を指定
拒否	Deny		string	true または false を指定
編集​​	Edit		string	true または false を指定
検索	LookUp		string	true または false を指定
既読	Read		string	true または false を指定
ドロワー	Drawer		string	ドロワー名を入力
加算	Add		string	true または false を指定
Delete キー	Delete		string	true または false を指定
拒否	Deny		string	true または false を指定
編集​​	Edit		string	true または false を指定
検索	LookUp		string	true または false を指定
既読	Read		string	true または false を指定
GroupName	GroupName		string	グループ名を入力

戻り値

名前	パス	型	説明
groupId	groupId	string	グループ ID 値
groupPermissionException	groupPermissionException	string	グループのアクセス許可の例外
isSet	isSet	boolean	アクセス許可が適用されましたか

グループの取得

操作 ID:

GetGroups

ユーザーおよびグループの管理に使用できるグループを取得

パラメーター

名前	キー	必須	型	説明
トークン	X-Authorization		string	トークン認証

戻り値

名前	パス	型	説明
		array of object
ID	id	string	グループ ID 値
mfa	mfa	integer	mfa 値
mfaRequired	mfaRequired	integer	mfa の要求値
名前	name	string	グループ名の値

グループの変更

操作 ID:

ModifyGroup

グループのアクセス許可の変更

パラメーター

名前	キー	必須	型	説明
Token	X-Authorization		string	トークン認証
AccessToApproveDocsOnly	AccessToApproveDocsOnly		string	true または false を指定
AllowAccessToReports	AllowAccessToReports		string	true または false を指定
コメント	Comments		string	コメントを入力
EnableMfa	EnableMfa		string	true または false を指定
EnforceMfaForUsers	EnforceMfaForUsers		string	true または false を指定
FirmFlowRoutingNotification	FirmFlowRoutingNotification		string	true または false を指定
FullAccessToDocTracking	FullAccessToDocTracking		string	true または false を指定
GroupName	GroupName		string	グループ名を入力
MfaRequired	MfaRequired		string	true または false を指定
PermissonToApproveDocs	PermissonToApproveDocs		string	true または false を指定
RenameGroup	RenameGroup		string	新しいグループ名を入力
許可	Allow		array of string	許可
拒否	Deny		array of string	拒否
IsAllowAll	IsAllowAll		string	true または false を指定
IsDenyAll	IsDenyAll		string	true または false を指定
ReportType	ReportType		string	true または false を指定
UploadLocation	UploadLocation		string	アップロード場所を入力
Users	Users		array of string	Users

戻り値

名前	パス	型	説明
groupId	groupId	string	グループ ID 値
isModified	isModified	boolean	グループは変更されましたか
mfaException	mfaException	string	mfa の例外
modifyGroupException	modifyGroupException	string	グループの例外を変更

グループを作成

操作 ID:

CreateGroup

アクセス許可グループを作成

パラメーター

名前	キー	必須	型	説明
トークン	X-Authorization		string	トークン認証
AccessToApproveDocsOnly	AccessToApproveDocsOnly		string	true または false を指定
AllowAccessToReports	AllowAccessToReports		string	true または false を指定
コメント	Comments		string	コメントを入力
EnableMfa	EnableMfa		string	true または false を指定
EnforceMfaForUsers	EnforceMfaForUsers		string	true または false を指定
FirmFlowRoutingNotification	FirmFlowRoutingNotification		string	true または false を指定
FullAccessToDocTracking	FullAccessToDocTracking		string	true または false を指定
GroupName	GroupName		string	グループ名を入力
MfaRequired	MfaRequired		string	true または false を指定
PermissonToApproveDocs	PermissonToApproveDocs		string	true または false を指定
許可	Allow		array of string	許可
拒否	Deny		array of string	拒否
IsAllowAll	IsAllowAll		string	true または false を指定
IsDenyAll	IsDenyAll		string	true または false を指定
ReportType	ReportType		string	true または false を指定
UploadLocation	UploadLocation		string	アップロード場所を入力
Users	Users		array of string	Users

戻り値

名前	パス	型	説明
createGroupException	createGroupException	string	グループの例外を作成
groupId	groupId	string	グループ ID 値
isCreated	isCreated	boolean	グループは作成されましたか
mfaException	mfaException	string	mfa ステータス

トークンの検証

操作 ID:

ValidateToken

トークンのステータスを検証

パラメーター

名前	キー	必須	型	説明
トークン	X-Authorization		string	トークン認証

戻り値

応答

boolean

ドキュメント インデックスの取得

操作 ID:

GetDocumentIndexes

ドキュメントのインデックスを取得

パラメーター

名前	キー	必須	型	説明
DocumentId	documentId	True	string	ドキュメント ID を入力
トークン	X-Authorization		string	トークン認証

戻り値

名前	パス	型	説明
		array of object
indexId	indexId	string	インデックス ID 値
indexValue	indexValue	string	インデックス値

ドキュメント ステータスの公開

操作 ID:

PublishDocumentStatus

ClientFlow からドキュメントを公開または非公開にします。

パラメーター

名前	キー	必須	型	説明
DocumentId	documentId	True	string	ドキュメント ID を入力
トークン	X-Authorization		string	トークン認証
IsPublished	IsPublished	True	string	true または false を指定

戻り値

名前	パス	型	説明
		array of object
documentException	documentException	string	ドキュメントの例外
documentId	documentId	string	ドキュメント ID の値
isPublished	isPublished	boolean	公開されたドキュメントです

ドキュメント 再インデックス

操作 ID:

DocumentReindex

ドキュメントのインデックスを再作成

パラメーター

名前	キー	必須	型	説明
Token	X-Authorization		string	トークン認証
DocumentIds	DocumentIds		array of string	DocumentIds
IndexId	IndexId		string	インデックス ID を入力
IndexValue	IndexValue		string	インデックス値の入力

戻り値

名前	パス	型	説明
		array of object
documentId	documentId	string	ドキュメント ID の値
isReIndexed	isReIndexed	boolean	ドキュメントのインデックスを再作成されます
reIndexDocumentException	reIndexDocumentException	string	ドキュメント例外のインデックスを再作成

ドキュメントの作成

操作 ID:

CreateDocument

インデックス付きのドキュメント レコードを作成

パラメーター

名前	キー	必須	型	説明
トークン	X-Authorization		string	トークン認証
DrawerId	DrawerId		string	ドロワー ID を入力
IndexId	IndexId		string	インデックス ID を入力
IndexValue	IndexValue		string	インデックス値の入力

戻り値

名前	パス	型	説明
documentId	documentCreate.documentId	string	ドキュメント ID の値
errorMessage	documentCreate.errorMessage	string	エラー メッセージ
errorMessage	indexValidation.errorMessage	string	エラー メッセージ
エラー	indexValidation.errors	array of	エラー
isValid	indexValidation.isValid	boolean	ドキュメントの有効です

ドキュメントの履歴を取得

操作 ID:

GetDocumentHistory

ドキュメントの履歴を取得

パラメーター

名前	キー	必須	型	説明
DocumentId	documentId	True	string	ドキュメント ID を入力
トークン	X-Authorization		string	トークン認証

戻り値

名前	パス	型	説明
documentAudit	documentAudit	array of	documentAudit
documentHistoryException	documentHistoryException	string	document History Exception
documentId	documentId	string	ドキュメント ID の値
mergeDocHistory	mergeDocHistory	array of	mergeDocHistory

ドキュメントの検索

操作 ID:

DocumentSearch

ユーザーがアクセスできるすべてのドキュメントを指定されたドロワーにロードします。

パラメーター

名前	キー	必須	型	説明
トークン	X-Authorization		string	トークン認証
DrawerId	DrawerId		string	ドロワー ID を入力
IndexId	IndexId		string	インデックス ID を入力
IndexValue	IndexValue		string	インデックス値の入力
NumberOfRows	NumberOfRows		integer	行数を入力
PageNumber	PageNumber		integer	パージ数を入力
SortField	SortField		string	並び替えフィールドの入力
SortOrder	SortOrder		string	並べ替え順の入力

戻り値

名前	パス	型	説明
documentIds	documentIds	array of string	documentIds
documentSearchCount	documentSearchCount	integer	ドキュメント検索数

ドキュメントの状態を取得

操作 ID:

GetDocumentStatus

ドキュメントの状態を取得

パラメーター

名前	キー	必須	型	説明
Token	X-Authorization		string	トークン認証
body	body		array of string

戻り値

名前	パス	型	説明
		array of object
documentId	documentId	string	ドキュメント ID の値
documentStatusException	documentStatusException	string	ドキュメント ステータスの例外
drawerId	drawerId	string	ドロワー ID 値
fileSize	fileSize	string	ファイル サイズの値
isArchived	isArchived	boolean	アーカイブされたドキュメントです
isCheckedOut	isCheckedOut	boolean	チェック アウトされたドキュメントです
isEncrypted	isEncrypted	boolean	暗号化されたドキュメントです
isFiled	isFiled	boolean	提出されたドキュメントです
isInRedactionQueue	isInRedactionQueue	boolean	編集キュー内のドキュメントです
isInTaxsortQueue	isInTaxsortQueue	boolean	Taxsort キュー内のドキュメントです
isLocked	isLocked	boolean	ロックされたドキュメントです
isOfficeDocument	isOfficeDocument	boolean	Office Document のドキュメントです
isPublished	isPublished	boolean	公開されたドキュメントです
isUndergoingMerging	isUndergoingMerging	boolean	マージ中のドキュメントです
localFile	localFile	string	ローカル ファイルのドキュメントです
noEdit	noEdit	boolean	編集値が無い
ページ	pages	integer	ドキュメントのページ
レビュー済み	reviewed	boolean	確認済みのステータス
taxSort	taxSort	boolean	taxsort されたドキュメントです
種類	type	string	ファイルのタイプ
バージョン	version	integer	ドキュメントのバージョン

ドキュメントをコピー

操作 ID:

CopyDocument

ドキュメントをコピー

パラメーター

名前	キー	必須	型	説明
Token	X-Authorization		string	トークン認証
DocumentIds	DocumentIds		array of string	DocumentIds
IndexId	IndexId		string	インデックス ID を入力
IndexValue	IndexValue		string	インデックス値の入力

戻り値

名前	パス	型	説明
		array of object
copyDocumentException	copyDocumentException	string	ドキュメント例外をコピー
documentId	documentId	string	ドキュメント ID の値
isCopied	isCopied	boolean	ドキュメントはコピーされましたか
newDocumentId	newDocumentId	string	新しいドキュメント ID

ドキュメントを削除する

操作 ID:

DocumentDelete

ドキュメントを削除

パラメーター

名前	キー	必須	型	説明
DocumentId	documentId	True	string	ドキュメント ID を入力
トークン	X-Authorization		string	トークン認証

戻り値

名前	パス	型	説明
		array of object
deleteDocumentException	deleteDocumentException	string	ドキュメントの例外を削除
documentId	documentId	string	ドキュメント ID の値
isDeleted	isDeleted	boolean	ドキュメントを削除します

ドキュメントを取得

操作 ID:

GetDocument

ドキュメントをダウンロード

パラメーター

名前	キー	必須	型	説明
DocumentId	documentId	True	string	ドキュメント ID を入力
トークン	X-Authorization		string	トークン認証

戻り値

ドロワー インデックスを取得

操作 ID:

GetDrawerIndexes

ドロワーに設定されているドキュメント インデックスのリストを取得

パラメーター

名前	キー	必須	型	説明
DrawerId	drawerId	True	string	ドロワー ID を入力
トークン	X-Authorization		string	トークン認証

戻り値

名前	パス	型	説明
		array of object
childIndexId	childIndexId	string	子インデックス ID 値
indexId	indexId	string	インデックス ID 値
indexName	indexName	string	インデックス名の値
indexType	indexType	string	インデックス タイプの値
長さ	length	integer	ドロワー インデックスの長さ
listId	listId	integer	ID 値のリスト
lookupAutoUpdate	lookupAutoUpdate	boolean	ルックアップ自動更新
必須	required	boolean	必要なインデックスです

ドロワーを取得

操作 ID:

GetDrawers

ログインしたユーザーがアクセスできるドロワーを取得

パラメーター

名前	キー	必須	型	説明
トークン	X-Authorization		string	トークン認証

戻り値

名前	パス	型	説明
		array of object
drawerID	drawerID	string	ドロワー ID 値
drawerName	drawerName	string	ドロワー名の値
追加	permissions.add	boolean	値の追加
削除	permissions.delete	boolean	値を削除
編集	permissions.edit	boolean	値の編集
lookupManagement	permissions.lookupManagement	boolean	lookupManagement value
ビュー	permissions.view	boolean	ビューの値

パスワード ポリシーの取得

操作 ID:

GetPasswordPolicy

会社のパスワード ポリシーを取得

パラメーター

名前	キー	必須	型	説明
トークン	X-Authorization		string	トークン認証

戻り値

名前	パス	型	説明
clientId	passwordPolicy.clientId	string	クライアント ID の値
forbidden_pwd_words	passwordPolicy.forbidden_pwd_words	array of string	forbidden_pwd_words
lockout_threshold	passwordPolicy.lockout_threshold	integer	lockout threshold
max_length	passwordPolicy.max_length	integer	パスワードの最大長
max_login_similarity	passwordPolicy.max_login_similarity	string	最大ログインの類似性
max_pwd_age	passwordPolicy.max_pwd_age	integer	パスワードの最長年齢
max_repeat_chars	passwordPolicy.max_repeat_chars	string	パスワードの最大繰り返し文字
max_sequential_chars	passwordPolicy.max_sequential_chars	string	最大順次文字数
mfa	passwordPolicy.mfa	integer	mfa 値
min_length	passwordPolicy.min_length	integer	パスワードの最小の長さ
pwd_req_alpha	passwordPolicy.pwd_req_alpha	integer	アルファ パスワードの要件
pwd_req_lower	passwordPolicy.pwd_req_lower	integer	より低いパスワード要件
pwd_req_number	passwordPolicy.pwd_req_number	integer	パスワード数の要件
pwd_req_symbol	passwordPolicy.pwd_req_symbol	integer	記号パスワードの要件
pwd_req_upper	passwordPolicy.pwd_req_upper	integer	より高いパスワード要件
passwordPolicyException	passwordPolicyException	string	passwordPolicyException

マスター成果物を削除

操作 ID:

DeleteMasterDeliverable

マスター成果物を削除

パラメーター

名前	キー	必須	型	説明
Token	X-Authorization		string	トークン認証
サービスの種類	ServiceType		string	サービスの種類
ドロワー名	DrawerName		string	ドロワー名
DeliverableNames	DeliverableNames		array of string	DeliverableNames

戻り値

名前	パス	型	説明
		array of object
削除状態	isDeleted	boolean	削除状態
回答メッセージ	responseMessage	string	回答メッセージ

マスター成果物を取得する

操作 ID:

GetMasterDeliverable

マスター成果物を取得する

パラメーター

名前	キー	必須	型	説明
Token	X-Authorization		string	トークン認証
ぺージ番号	PageNumber		integer	ぺージ番号
ページ サイズ	pageSize		integer	ページ サイズ
サービスの種類	ServiceType		string	サービスの種類
ドロワー名	DrawerName		string	ドロワー名

戻り値

名前	パス	型	説明
deliverableList	deliverableList	array of object	deliverableList
成果物の名前	deliverableList.deliverableName	string	成果物の名前
拡張の種類	deliverableList.extensionType	string	拡張の種類
Due Date	deliverableList.dueDate	string	Due Date
最初の拡張	deliverableList.firstExtension	string	最初の拡張
2 番目の拡張	deliverableList.secondExtension	string	2 番目の拡張
3 番目の拡張	deliverableList.thirdExtension	string	3 番目の拡張
内線番号	deliverableList.extension	string	内線番号
Action	deliverableList.action	string	Action
責務 ID	deliverableList.obligationId	string	責務 ID
固定管理オプション	deliverableList.firmManagedOption	string	固定管理オプション
合計レコード数	totalRecords	string	合計レコード数
回答メッセージ	responseMessage	string	回答メッセージ

マスター成果物を編集

操作 ID:

EditMasterDeliverable

マスター成果物を編集

パラメーター

名前	キー	必須	型	説明
Token	X-Authorization		string	トークン認証
現在の成果物名	currentdeliverableName		string	現在の成果物名
成果物の名前を更新する	updatedeliverableName		string	成果物の名前を更新する
Due Date	dueDate		string	Due Date
最初の拡張	firstExtension		string	最初の拡張
2 番目の拡張	secondExtension		string	2 番目の拡張
3 番目の拡張	thirdExtension		string	3 番目の拡張
カレンダーまたは会計	calenderOrFiscal		string	カレンダーまたは会計
内線番号	extension		integer	内線番号
サービスの種類	serviceType		string	サービスの種類
ドロワー名	drawerName		string	ドロワー名

戻り値

名前	パス	型	説明
状態を更新する	isUpdated	boolean	状態を更新する
回答メッセージ	responseMessage	string	回答メッセージ

マスター成果物を追加

操作 ID:

AddMasterDeliverable

マスター成果物を追加

パラメーター

名前	キー	必須	型	説明
Token	X-Authorization		string	トークン認証
成果物の名前	deliverableName		string	成果物の名前
Due Date	dueDate		string	Due Date
最初の拡張	firstExtension		string	最初の拡張
2 番目の拡張	secondExtension		string	2 番目の拡張
3 番目の拡張	thirdExtension		string	3 番目の拡張
カレンダーまたは会計	calenderOrFiscal		string	カレンダーまたは会計
内線番号	extension		integer	内線番号
サービスの種類	ServiceType		string	サービスの種類
ドロワー名	DrawerName		string	ドロワー名

戻り値

名前	パス	型	説明
保存されている	isSaved	boolean	保存されている
回答メッセージ	responseMessage	string	回答メッセージ

ユーザー ドキュメント セキュリティを取得

操作 ID:

GetUserDocumentSecurity

ログインごとにユーザー ドキュメントのセキュリティを取得

パラメーター

名前	キー	必須	型	説明
LoginId	loginId	True	string	ログイン ID の入力
CabinetName	cabinetName	True	string	キャビネット名を入力
DrawerName	drawerName	True	string	ドロワー名を入力
トークン	X-Authorization		string	トークン認証

戻り値

名前	パス	型	説明
cabinetName	cabinetName	string	キャビネット名
documentSecurity	documentSecurity	string	ドキュメント セキュリティ値
drawerName	drawerName	string	ドロワー名の値
getUserDocSecurityException	getUserDocSecurityException	string	ユーザー ドキュメント セキュリティの例外
loginId	loginId	string	ログイン ID 値

ユーザー ドキュメント セキュリティを設定

操作 ID:

SetUserDocSecurity

ユーザーのドキュメント セキュリティのアクセス許可を割り当てます

パラメーター

名前	キー	必須	型	説明
トークン	X-Authorization		string	トークン認証
CabinetName	CabinetName		string	キャビネット名を入力
DocSecurityType	DocSecurityType		string	ドキュメント セキュリティ タイプを入力
IndexName	IndexName		string	インデックス名を入力
オペレーション	Operation		string	オペレーションの入力
Values	Values		array of string	Values
DrawerName	DrawerName		string	ドロワー名を入力
LoginId	LoginId		string	ログイン ID の入力

戻り値

名前	パス	型	説明
isSetUserDocSecurity	isSetUserDocSecurity	boolean	ユーザー ドキュメント セキュリティは適用されましたか
loginId	loginId	string	ログイン ID 値
setUserDocSecurityException	setUserDocSecurityException	string	ユーザー ドキュメント セキュリティの例外を設定

ユーザーのアクセス許可を取得

操作 ID:

GetUserPermission

ユーザーのアクセス許可を取得

パラメーター

名前	キー	必須	型	説明
ログイン	login	True	string	ログイン入力
トークン	X-Authorization		string	トークン認証

戻り値

名前	パス	型	説明
キャビネット	cabinet	string	キャビネット名の値
追加	cabinetPermission.add	boolean	値の追加
削除	cabinetPermission.delete	boolean	値を削除
拒否	cabinetPermission.deny	boolean	値を拒否
編集	cabinetPermission.edit	boolean	値の編集
検索	cabinetPermission.lookUp	boolean	検索値
読み込み	cabinetPermission.read	boolean	読み取り値
drawerPermissions	drawerPermissions	array of object	drawerPermissions
ドロワー	drawerPermissions.drawer	string	ドロワー名の値
追加	drawerPermissions.permission.add	boolean	値の追加
削除	drawerPermissions.permission.delete	boolean	値を削除
拒否	drawerPermissions.permission.deny	boolean	値を拒否
編集	drawerPermissions.permission.edit	boolean	値の編集
検索	drawerPermissions.permission.lookUp	boolean	検索値
読み込み	drawerPermissions.permission.read	boolean	読み取り値
getUserPermissionException	getUserPermissionException	string	ユーザーのアクセス許可の例外
loginId	loginId	string	ログイン ID 値

ユーザーのアクセス許可を設定

操作 ID:

SetUserPermissions

ユーザーにアクセス許可を割り当てます

パラメーター

名前	キー	必須	型	説明
トークン	X-Authorization		string	トークン認証
キャビネット	Cabinet		string	キャビネット名を入力
加算	Add		string	true または false を指定
Delete キー	Delete		string	true または false を指定
拒否	Deny		string	true または false を指定
編集​​	Edit		string	true または false を指定
検索	LookUp		string	true または false を指定
既読	Read		string	true または false を指定
ドロワー	Drawer		string	ドロワー名を入力
加算	Add		string	true または false を指定
Delete キー	Delete		string	true または false を指定
拒否	Deny		string	true または false を指定
編集​​	Edit		string	true または false を指定
検索	LookUp		string	true または false を指定
既読	Read		string	true または false を指定
LoginId	LoginId		string	ログイン ID の入力

戻り値

名前	パス	型	説明
isSetUserPermission	isSetUserPermission	boolean	ユーザーのアクセス許可を更新しましたか
loginId	loginId	string	ログイン ID 値
setUserPermissionException	setUserPermissionException	string	ユーザーのアクセス許可の例外を設定

ユーザーの作成

操作 ID:

CreateUsers

GoFileRoom および ClientFlow ユーザーをシステムに作成

パラメーター

名前	キー	必須	型	説明
UserType	userType		string	ユーザー タイプの入力
トークン	X-Authorization		string	トークン認証
AccountExpiresDate	AccountExpiresDate		string	アカウントの有効期限を入力
DisabledComments	DisabledComments		string	無効なコメントを入力
FullName	FullName		string	ユーザーの氏名
Groups	Groups		array of string	Groups
IsAccountExpires	IsAccountExpires		string	true または false を指定
IsAdvanceFlow	IsAdvanceFlow		string	true または false を指定
IsAllowAccessToReports	IsAllowAccessToReports		string	true または false を指定
IsAllowOffline	IsAllowOffline		string	true または false を指定
IsDisabled	IsDisabled		string	true または false を指定
IsFirmFlow	IsFirmFlow		string	true または false を指定
IsFirmFlowNotificationGroup	IsFirmFlowNotificationGroup		string	true または false を指定
IsFirmFlowNotificationUser	IsFirmFlowNotificationUser		string	true または false を指定
IsMfa	IsMfa		string	true または false を指定
IsUserAdministration	IsUserAdministration		string	true または false を指定
IsWorkflowManagerUser	IsWorkflowManagerUser		string	true または false を指定
ライセンスの種類	LicenseType		string	ライセンス タイプの入力
LoginName	LoginName		string	ログイン名を入力
ManagerEmail	ManagerEmail		string	管理者のメールを入力
Password	Password		string	パスワードを入力
許可	Allow		array of string	許可
拒否	Deny		array of string	拒否
IsAllowAll	IsAllowAll		string	true または false を指定
IsDenyAll	IsDenyAll		string	true または false を指定
ReportType	ReportType		string	true または false を指定
UploadLocation	UploadLocation		string	アップロード場所を入力

戻り値

名前	パス	型	説明
createUserException	createUserException	string	ユーザーの例外を作成
isCreated	isCreated	boolean	ユーザーは作成されましたか
mfaException	mfaException	string	mfa の例外
userId	userId	string	ユーザー ID 値

ユーザーの取得

操作 ID:

GetUsers

ログインしたユーザーの GFR ユーザーを取得

パラメーター

名前	キー	必須	型	説明
UserType	userType		string	ユーザー タイプの入力
トークン	X-Authorization		string	トークン認証

戻り値

名前	パス	型	説明
		array of object
isActive	isActive	boolean	ユーザーはアクティブです
loginId	loginId	string	ログイン ID 値

ユーザーを削除

操作 ID:

DeleteUser

GoFileRoom および ClientFlow ユーザーをシステムから削除

パラメーター

名前	キー	必須	型	説明
トークン	X-Authorization		string	トークン認証
LoginId	LoginId		string	ユーザーのログイン ID を入力
UserType	UserType		string	ユーザー タイプの入力

戻り値

名前	パス	型	説明
deleteUserException	deleteUserException	string	ユーザーの例外を削除
isDeleted	isDeleted	boolean	ログインは削除されましたか
loginId	loginId	string	ログイン ID 値

ユーザーを変更

操作 ID:

ModifyUser

ユーザーのアクセス許可の変更

パラメーター

名前	キー	必須	型	説明
UserType	userType		string	ユーザー タイプの入力
トークン	X-Authorization		string	トークン認証
AccountExpiresDate	AccountExpiresDate		string	アカウントが切れる日付
DisabledComments	DisabledComments		string	コメントを入力
FullName	FullName		string	フル ネームの入力
Groups	Groups		array of string	Groups
IsAccountExpires	IsAccountExpires		string	true または false を指定
IsAdvanceFlow	IsAdvanceFlow		string	true または false を指定
IsAllowAccessToReports	IsAllowAccessToReports		string	true または false を指定
IsAllowOffline	IsAllowOffline		string	true または false を指定
IsChangeNextLogin	IsChangeNextLogin		string	true または false を指定
IsDisabled	IsDisabled		string	true または false を指定
IsFirmFlow	IsFirmFlow		string	true または false を指定
IsFirmFlowNotificationGroup	IsFirmFlowNotificationGroup		string	true または false を指定
IsFirmFlowNotificationUser	IsFirmFlowNotificationUser		string	true または false を指定
IsMfa	IsMfa		string	true または false を指定
IsUserAdministration	IsUserAdministration		string	true または false を指定
IsWorkflowManagerUser	IsWorkflowManagerUser		string	true または false を指定
ライセンスの種類	LicenseType		string	ライセンス タイプの入力
LoginName	LoginName		string	ログイン名を入力
ManagerEmail	ManagerEmail		string	管理者のメールを入力
Password	Password		string	パスワードを入力
許可	Allow		array of string	許可
拒否	Deny		array of string	拒否
IsAllowAll	IsAllowAll		string	true または false を指定
IsDenyAll	IsDenyAll		string	true または false を指定
ReportType	ReportType		string	true または false を指定
UploadLocation	UploadLocation		string	アップロード場所を入力

戻り値

名前	パス	型	説明
isModified	isModified	boolean	ユーザーが変更されました
mfaException	mfaException	string	mfa の例外
modifyUserException	modifyUserException	string	ユーザーの例外を変更
userId	userId	string	ユーザー ID 値

ユーザー情報の取得 V2

操作 ID:

GetUserInfoV2

ユーザー名を取得

パラメーター

名前	キー	必須	型	説明
Token	X-Authorization		string	トークン認証
ログイン名	LoginName		string	ログイン名
ユーザーの種類	UserType		string	ユーザーの種類

戻り値

名前	パス	型	説明
User ID	userID	string	User ID
ログイン ID	loginID	string	ログイン ID
正式な名前	fullName	string	正式な名前
作成日	createDate	string	作成日
作成者	createdBy	string	作成者
説明設定	description	string	説明設定
Disabled	disabled	integer	Disabled
管理者により無効化	disabledByAdmin	boolean	管理者により無効化
パスワード有効期限	passwordExpireDate	string	パスワード有効期限
パスワード変更を強制する	forcePasswordChange	boolean	パスワード変更を強制する
パスワード変更日	passwordChangeDate	string	パスワード変更日
パスワード変更間隔	passwordChangeInterval	integer	パスワード変更間隔
ライセンスの種類	licenseType	string	ライセンスの種類
オフライン	offline	boolean	オフライン
レポート	reports	boolean	レポート
システム管理者	systemAdmin	boolean	システム管理者
署名	signature	string	署名
場所 ID	locationID	string	場所 ID
ドロワー設定の権限がある	hasDrawerSetupRights	string	ドロワー設定の権限がある
税フロー	taxFlow	boolean	税フロー
メール通知	emailNotify	boolean	メール通知
メール通知グループ	emailNotifyGroup	boolean	メール通知グループ
メール通知イベントの管理ユーザー	emailNotifyEventMgmtUsers	boolean	メール通知イベントの管理ユーザー
メール通知イベントの管理グループ	emailNotifyEventMgmtGroups	boolean	メール通知イベントの管理グループ
ポータル ユーザー管理	portalUserAdministration	boolean	ポータル ユーザー管理
内部ユーザー管理	internalUserAdministration	boolean	内部ユーザー管理
ワークフロー マネージャー ユーザー	workflowManagerUser	boolean	ワークフロー マネージャー ユーザー
管理者 ID	managerId	string	管理者 ID
マネージャー ログイン ID	managerLoginId	string	マネージャー ログイン ID
マネージャーの氏名	managerFullName	string	マネージャーの氏名
マネージャーである	isManager	integer	マネージャーである
Oberon ユーザー	oberonUser	integer	Oberon ユーザー
管理者である	isAdmin	integer	管理者である
最終ログイン	lastLogin	string	最終ログイン
グループ	groups	array of string	グループ

ユーザー情報を取得

操作 ID:

GetUserInfo

GFR ユーザー情報を取得

パラメーター

名前	キー	必須	型	説明
トークン	X-Authorization		string	トークン認証
LoginName	LoginName	True	string	LoginName の入力
UserType	UserType	True	string	UserType の選択

戻り値

名前	パス	型	説明
createDate	createDate	string	createDate
createdBy	createdBy	string	createdBy
説明	description	string	説明
無効	disabled	integer	無効
disabledByAdmin	disabledByAdmin	boolean	disabledByAdmin
emailNotify	emailNotify	boolean	emailNotify
emailNotifyEventMgmtGroups	emailNotifyEventMgmtGroups	boolean	emailNotifyEventMgmtGroups
emailNotifyEventMgmtUsers	emailNotifyEventMgmtUsers	boolean	emailNotifyEventMgmtUsers
emailNotifyGroup	emailNotifyGroup	boolean	emailNotifyGroup
forcePasswordChange	forcePasswordChange	boolean	forcePasswordChange
fullName	fullName	string	fullName
hasDrawerSetupRights	hasDrawerSetupRights	string	hasDrawerSetupRights
isAdmin	isAdmin	integer	isAdmin
isManager	isManager	integer	isManager
licenseType	licenseType	string	licenseType
locationID	locationID	string	locationID
loginID	loginID	string	loginID
managerFullName	managerFullName	string	managerFullName
managerId	managerId	string	managerId
managerLoginId	managerLoginId	string	managerLoginId
oberonUser	oberonUser	integer	oberonUser
オフライン	offline	boolean	オフライン
passwordChangeDate	passwordChangeDate	string	passwordChangeDate
passwordChangeInterval	passwordChangeInterval	integer	passwordChangeInterval
passwordExpireDate	passwordExpireDate	string	passwordExpireDate
報告	reports	boolean	報告
署名	signature	string	署名
systemAdmin	systemAdmin	boolean	systemAdmin
taxFlow	taxFlow	boolean	taxFlow
userAdministration	userAdministration	integer	userAdministration
userID	userID	string	userID
workflowManagerUser	workflowManagerUser	boolean	workflowManagerUser

ライセンスを取得

操作 ID:

GetLicenses

ライセンス数を取得

パラメーター

名前	キー	必須	型	説明
ライセンスの種類	license		string	ライセンス タイプの入力
トークン	X-Authorization		string	トークン認証

戻り値

名前	パス	型	説明
assignedLicenses	assignedLicenses	string	割り当て済みのライセンス数
getLicenseException	getLicenseException	string	ライセンスの例外を取得
ライセンス	license	string	ライセンス名
メッセージ	message	string	メッセージ
totalLicenses	totalLicenses	string	ライセンス合計数

レポートのリストを取得

操作 ID:

GetListOfReports

ユーザー管理に使用できるレポートを取得

パラメーター

名前	キー	必須	型	説明
トークン	X-Authorization		string	トークン認証

戻り値

名前	パス	型	説明
報告	reports	array of object	報告
reportName	reports.reportName	array of string	reportName
reportType	reports.reportType	string	レポート タイプの値
reportsException	reportsException	string	例外値をレポート

ログアウト

操作 ID:

Logout

アプリケーションのログアウト

パラメーター

名前	キー	必須	型	説明
トークン	X-Authorization		string	トークン認証

戻り値

名前	パス	型	説明
isLogoutSuccess	isLogoutSuccess	boolean	ログアウトが正常に完了しました

ログイン

操作 ID:

Login

ユーザーをアプリケーションにログイン

パラメーター

名前	キー	必須	型	説明
LoginName	LoginName	True	string	ログイン名を入力
パスワード	Password	True	password	パスワードを入力

戻り値

名前	パス	型	説明
authSuccess	authSuccess	boolean	認証が正常に作成されました
authenticationResponse	authenticationResponse	string	認証応答の値
customerId	customerId	string	顧客 ID の値
errorCode	errorCode	string	エラー コード値
idleSessionTimeoutMinutes	idleSessionTimeoutMinutes	integer	アイドル セッション タイムアウト分
loneStarFirmId	loneStarFirmId	string	唯一のスター会社の ID
loneStarValidated	loneStarValidated	boolean	唯一のスター検証
トークン	token	string	トークン値
userId	userId	string	ユーザー ID 値
userName	userName	string	ユーザー名の値

ワークフロー V2 をルーティング

操作 ID:

RouteWorkflowV2

ワークフロー V2 をルーティング

パラメーター

名前	キー	必須	型	説明
Token	X-Authorization		string	トークン認証
filingId	filingId		array of integer	filingId
CurrentStep	CurrentStep		array of string	CurrentStep
Complete	Complete		boolean	Complete
完了日	CompletedDate		string	完了日
次のステップ	NextStep		string	次のステップ
割り当て先	AssignedTo		string	割り当て先
割り当て日付	AssignedDate		string	割り当て日付
優先順位	Priority		string	優先順位
Status	Status		string	Status
ルーティング メモ	RoutingNote		string	ルーティング メモ
メール通知	emailNotify		boolean	メール通知

戻り値

名前	パス	型	説明
申告 ID	filingId	string	申告 ID
ルーティングである	isRouted	boolean	ルーティングである

ワークフローを作成

操作 ID:

CreateWorkflow

ワークフローを作成

パラメーター

名前	キー	必須	型	説明
Token	X-Authorization		string	トークン認証
ドロワー名	Drawer		string	ドロワー名
サービスの種類	ServiceType		string	サービスの種類
フォルダー ID	folderId		string	フォルダー ID
クライアント名	ClientName		string	クライアント名
クライアント番号	ClientNumber		string	クライアント番号
エンゲージメントの種類	EngagementType		string	エンゲージメントの種類
PIC	PIC		string	PIC
年式	Year		string	年式
期間終了日	PeriodEnd		string	期間終了日
ワークフロー名	workflowName		string	ワークフロー名
説明設定	description	True	string	説明設定
状態の名前	statusName		string	状態の名前
成果物のアクション	action		string	成果物のアクション
現在の期日	currentduedate		string	現在の期日
元の期限	originalduedate		string	元の期限
成果物のフォーム	form		string	成果物のフォーム
Delivery Method	Delivery		string	Delivery Method
Destination	Destination		string	Destination
ソース ドキュメント	sourceDocument		string	ソース ドキュメント
メモ アクション	action		string	メモ アクション
メモの種類	noteType		string	メモの種類
メモ メッセージ	note		string	メモ メッセージ
情報フィールド名	name		string	情報フィールド名
情報フィールドの値	value		string	情報フィールドの値
責任フィールド	ResponsibleField		string	責任フィールド
責任フィールドの値	value		string	責任フィールドの値

戻り値

名前	パス	型	説明
申告 ID	filingId	integer	申告 ID
エラー コメント	errorComment	string	エラー コメント
Status	status	boolean	Status
errorMessage	errorMessage	array of string	errorMessage

ワークフローを削除

操作 ID:

DeleteWorkflows

ワークフローを削除

パラメーター

名前	キー	必須	型	説明
Token	X-Authorization		string	トークン認証
filingId	filingId		array of integer	filingId

戻り値

名前	パス	型	説明
削除済みの状態	isDeleted	boolean	削除済みの状態
申告 ID	filingId	string	申告 ID

ワークフローを編集

操作 ID:

EditWorkflow

ワークフローを編集

パラメーター

名前	キー	必須	型	説明
Token	X-Authorization		string	トークン認証
申告 ID	filingId		integer	申告 ID
クライアント名	ClientName		string	クライアント名
クライアント番号	ClientNumber		string	クライアント番号
エンゲージメントの種類	EngagementType		string	エンゲージメントの種類
PIC	PIC		string	PIC
年式	Year		string	年式
期間終了日	PeriodEnd		string	期間終了日
成果物の名前	action		string	成果物の名前
現在の期日	currentduedate		string	現在の期日
元の期限	originalduedate		string	元の期限
添付	form		string	添付
メモ アクション	action		string	メモ アクション
メモの種類	noteType		string	メモの種類
noteid	noteid		array of string	noteid
メモ メッセージ	note		string	メモ メッセージ
情報フィールド名	name		string	情報フィールド名
情報フィールドの値	value		string	情報フィールドの値
Delivery Method	Delivery		string	Delivery Method
Destination	Destination		string	Destination
ソース ドキュメント	sourceDocument		string	ソース ドキュメント
責任フィールド	responsibleField		string	責任フィールド
割り当て先	value		string	割り当て先
ドキュメント索引再作成	reindexDocs		boolean	ドキュメント索引再作成

戻り値

名前	パス	型	説明
申告 ID	filingId	integer	申告 ID
エラー コメント	errorComment	string	エラー コメント
Status	status	boolean	Status
errorMessage	errorMessage	array of object	errorMessage
件名	errorMessage.name	string	件名
Status	errorMessage.status	boolean	Status
エラー コメント	errorMessage.errorComment	string	エラー コメント

子インデックスを取得

操作 ID:

GetChildIndexes

親リスト値が選択されたときに提供されるリスト ID に基づいて、子インデックス値のリストを取得します。

パラメーター

名前	キー	必須	型	説明
IndexId	indexId	True	string	インデックス ID を入力
ListId	listId	True	string	リスト ID を入力
トークン	X-Authorization		string	トークン認証

戻り値

名前	パス	型	説明
		array of object
childIndexId	childIndexId	string	子インデックス ID 値
childListId	childListId	integer	子リスト ID 値
hasChildren	hasChildren	boolean	インデックスには子インデックスがありますか
listEntryId	listEntryId	integer	入力 ID 値のリスト
listId	listId	integer	ID 値のリスト
値	value	string	値

追跡レポート (ワークフロー別)

操作 ID:

TrackingReportByWorkflow

追跡レポート (ワークフロー別)

パラメーター

名前	キー	必須	型	説明
Token	X-Authorization		string	トークン認証
ドロワー ID	DrawerId		string	ドロワー ID
サービスの種類	ServiceType		string	サービスの種類
エンゲージメントの種類	EngagementType		string	エンゲージメントの種類
Workflow	Workflow		string	Workflow
現在のステップ	CurrentStep		string	現在のステップ
PIC	PIC		string	PIC
割り当て先	AssignedTo		string	割り当て先
割り当て日	AssignedOn		string	割り当て日
ワークフローの説明	WorkflowDescription		string	ワークフローの説明
プロセス内のみ	InProcessOnly		string	プロセス内のみ
Status	Status		string	Status
優先順位	Priority		string	優先順位
責任	Responsible		string	責任
割り当て履歴	AssignmentHistory		string	割り当て履歴
送信元	ReceivedFrom		string	送信元
受信日	ReceivedOn		string	受信日
送信先	SentTo		string	送信先
送信日	SentOn		string	送信日
完了者	CompletedBy		string	完了者
完了日	CompletedOn		string	完了日
現在の期日	CurrentDueDate		string	現在の期日
ステップの日数	DaysAtStep		string	ステップの日数
ステップの合計日数	TotalDaysAtStep		string	ステップの合計日数
ルーティングの間の日数	DaysBetweenRoutings		string	ルーティングの間の日数
プロセスの合計日数	TotalDaysInProcess		string	プロセスの合計日数
利用可能	Accountable		string	利用可能
ルーティングの詳細	RoutingDetails		string	ルーティングの詳細
Last Updated	LastUpdated		string	Last Updated
InformationFields	InformationFields		array of string	InformationFields
インデックス	Indexes		array of string	インデックス
ぺージ番号	PageNumber		string	ぺージ番号

戻り値

名前	パス	型	説明
合計レコード数	totalRecords	integer	合計レコード数
ぺージ番号	pageNumber	string	ぺージ番号
ページ サイズ	pageSize	integer	ページ サイズ
合計ページ数	totalPages	integer	合計ページ数
firmFlowReportResponse	firmFlowReportResponse	array of object	firmFlowReportResponse
クライアント名	firmFlowReportResponse.clientName	string	クライアント名
クライアント番号	firmFlowReportResponse.clientNumber	string	クライアント番号
ドロワー ID	firmFlowReportResponse.drawerId	string	ドロワー ID
サービスの種類	firmFlowReportResponse.serviceType	string	サービスの種類
エンゲージメントの種類	firmFlowReportResponse.engagementType	string	エンゲージメントの種類
Workflow	firmFlowReportResponse.workflow	string	Workflow
現在のステップ	firmFlowReportResponse.currentStep	string	現在のステップ
PIC	firmFlowReportResponse.pic	string	PIC
割り当て先	firmFlowReportResponse.assignedTo	string	割り当て先
割り当て日	firmFlowReportResponse.assignedOn	string	割り当て日
年式	firmFlowReportResponse.year	string	年式
期間終了日	firmFlowReportResponse.periodEnd	string	期間終了日
ワークフローの説明	firmFlowReportResponse.workflowDescription	string	ワークフローの説明
Progress	firmFlowReportResponse.progress	string	Progress
Status	firmFlowReportResponse.status	string	Status
優先順位	firmFlowReportResponse.priority	string	優先順位
eFile の (はい/いいえ)	firmFlowReportResponse.eFileYesOrNo	string	eFile の (はい/いいえ)
拡張版 (はい/いいえ)	firmFlowReportResponse.extendedYesOrNo	string	拡張版 (はい/いいえ)
受信日	firmFlowReportResponse.receivedOn	string	受信日
完了日	firmFlowReportResponse.completedOn	string	完了日
送信日	firmFlowReportResponse.sentOn	string	送信日
成果物	firmFlowReportResponse.deliverables	string	成果物
責任	firmFlowReportResponse.responsible	string	責任
割り当て履歴	firmFlowReportResponse.assignmentHistory	string	割り当て履歴
送信元	firmFlowReportResponse.receivedFrom	string	送信元
送信先	firmFlowReportResponse.sentTo	string	送信先
完了者	firmFlowReportResponse.completedBy	string	完了者
利用可能	firmFlowReportResponse.accountable	string	利用可能
現在の期日	firmFlowReportResponse.currentDueDate	string	現在の期日
元の期限	firmFlowReportResponse.originalDueDate	string	元の期限
ルーティングメモ	firmFlowReportResponse.routingNotes	string	ルーティングメモ
(はい/いいえ) の写真	firmFlowReportResponse.picYesOrNo	string	(はい/いいえ) の写真
(はい/いいえ) に割り当て済み	firmFlowReportResponse.assignedToYesOrNo	string	(はい/いいえ) に割り当て済み
延長された日付	firmFlowReportResponse.dateExtended	string	延長された日付
ステップの日数	firmFlowReportResponse.daysAtStep	string	ステップの日数
ステップの合計日数	firmFlowReportResponse.totalDaysAtStep	string	ステップの合計日数
ルーティングの間の日数	firmFlowReportResponse.daysBetweenRoutings	string	ルーティングの間の日数
プロセスの合計日数	firmFlowReportResponse.totalDaysInProcess	string	プロセスの合計日数
フォルダー ID	firmFlowReportResponse.folderID	string	フォルダー ID
申告 ID	firmFlowReportResponse.filingID	string	申告 ID
ワークフローの前回更新	firmFlowReportResponse.workflowLastUpdated	string	ワークフローの前回更新
informationFields	firmFlowReportResponse.informationFields	array of object	informationFields
名称	firmFlowReportResponse.informationFields.name	string	名称
価値	firmFlowReportResponse.informationFields.value	string	価値
routingSummary	firmFlowReportResponse.routingSummary	array of	routingSummary
responsibleUserOrGroups	firmFlowReportResponse.responsibleUserOrGroups	array of	responsibleUserOrGroups
FirmFlow の例外を取得する	getFirmFlowException	string	FirmFlow の例外を取得する

追跡レポート (成果物別) V2

操作 ID:

TrackingReportByDeliverableV2

追跡レポート (成果物別) V2

パラメーター

名前	キー	必須	型	説明
Token	X-Authorization		string	トークン認証
ドロワー ID	DrawerId		string	ドロワー ID
サービスの種類	ServiceType		string	サービスの種類
エンゲージメントの種類	EngagementType		string	エンゲージメントの種類
Workflow	Workflow		string	Workflow
現在のステップ	CurrentStep		string	現在のステップ
PIC	PIC		string	PIC
割り当て先	AssignedTo		string	割り当て先
割り当て日	AssignedOn		string	割り当て日
ワークフローの説明	WorkflowDescription		string	ワークフローの説明
プロセス内のみ	InProcessOnly		string	プロセス内のみ
Status	Status		string	Status
優先順位	Priority		string	優先順位
受信日	ReceivedOn		string	受信日
完了日	CompletedOn		string	完了日
送信日	SentOn		string	送信日
責任	Responsible		string	責任
割り当て履歴	AssignmentHistory		string	割り当て履歴
送信元	ReceivedFrom		string	送信元
送信先	SentTo		string	送信先
完了者	CompletedBy		string	完了者
利用可能	Accountable		string	利用可能
現在の期日	CurrentDueDate		string	現在の期日
元の期限	OriginalDueDate		string	元の期限
延長された日付	DateExtended		string	延長された日付
ステップの日数	DaysAtStep		string	ステップの日数
ステップの合計日数	TotalDaysAtStep		string	ステップの合計日数
ルーティングの間の日数	DaysBetweenRoutings		string	ルーティングの間の日数
プロセスの合計日数	TotalDaysInProcess		string	プロセスの合計日数
ルーティングの詳細	RoutingDetails		string	ルーティングの詳細
Last Updated	LastUpdated		string	Last Updated
InformationFields	InformationFields		array of string	InformationFields
インデックス	Indexes		array of string	インデックス
ぺージ番号	PageNumber		string	ぺージ番号

戻り値

名前	パス	型	説明
合計レコード数	totalRecords	integer	合計レコード数
ぺージ番号	pageNumber	string	ぺージ番号
ページ サイズ	pageSize	integer	ページ サイズ
合計ページ数	totalPages	integer	合計ページ数
firmFlowReportResponse	firmFlowReportResponse	array of object	firmFlowReportResponse
クライアント名	firmFlowReportResponse.clientName	string	クライアント名
クライアント番号	firmFlowReportResponse.clientNumber	string	クライアント番号
ドロワー ID	firmFlowReportResponse.drawerId	string	ドロワー ID
サービスの種類	firmFlowReportResponse.serviceType	string	サービスの種類
エンゲージメントの種類	firmFlowReportResponse.engagementType	string	エンゲージメントの種類
Workflow	firmFlowReportResponse.workflow	string	Workflow
現在のステップ	firmFlowReportResponse.currentStep	string	現在のステップ
PIC	firmFlowReportResponse.pic	string	PIC
割り当て先	firmFlowReportResponse.assignedTo	string	割り当て先
割り当て日	firmFlowReportResponse.assignedOn	string	割り当て日
年式	firmFlowReportResponse.year	string	年式
期間終了日	firmFlowReportResponse.periodEnd	string	期間終了日
ワークフローの説明	firmFlowReportResponse.workflowDescription	string	ワークフローの説明
Progress	firmFlowReportResponse.progress	string	Progress
Status	firmFlowReportResponse.status	string	Status
優先順位	firmFlowReportResponse.priority	string	優先順位
eFile の (はい/いいえ)	firmFlowReportResponse.eFileYesOrNo	string	eFile の (はい/いいえ)
拡張版 (はい/いいえ)	firmFlowReportResponse.extendedYesOrNo	string	拡張版 (はい/いいえ)
受信日	firmFlowReportResponse.receivedOn	string	受信日
完了日	firmFlowReportResponse.completedOn	string	完了日
送信日	firmFlowReportResponse.sentOn	string	送信日
成果物	firmFlowReportResponse.deliverables	string	成果物
責任	firmFlowReportResponse.responsible	string	責任
割り当て履歴	firmFlowReportResponse.assignmentHistory	string	割り当て履歴
送信元	firmFlowReportResponse.receivedFrom	string	送信元
送信先	firmFlowReportResponse.sentTo	string	送信先
完了者	firmFlowReportResponse.completedBy	string	完了者
利用可能	firmFlowReportResponse.accountable	string	利用可能
現在の期日	firmFlowReportResponse.currentDueDate	string	現在の期日
元の期限	firmFlowReportResponse.originalDueDate	string	元の期限
ルーティングメモ	firmFlowReportResponse.routingNotes	string	ルーティングメモ
(はい/いいえ) の写真	firmFlowReportResponse.picYesOrNo	string	(はい/いいえ) の写真
(はい/いいえ) に割り当て済み	firmFlowReportResponse.assignedToYesOrNo	string	(はい/いいえ) に割り当て済み
延長された日付	firmFlowReportResponse.dateExtended	string	延長された日付
ステップの日数	firmFlowReportResponse.daysAtStep	string	ステップの日数
ステップの合計日数	firmFlowReportResponse.totalDaysAtStep	string	ステップの合計日数
ルーティングの間の日数	firmFlowReportResponse.daysBetweenRoutings	string	ルーティングの間の日数
プロセスの合計日数	firmFlowReportResponse.totalDaysInProcess	string	プロセスの合計日数
フォルダー ID	firmFlowReportResponse.folderID	string	フォルダー ID
申告 ID	firmFlowReportResponse.filingID	string	申告 ID
以前の申告 ID	firmFlowReportResponse.priorFilingID	string	以前の申告 ID
Last Updated	firmFlowReportResponse.lastUpdated	string	Last Updated
informationFields	firmFlowReportResponse.informationFields	array of object	informationFields
名称	firmFlowReportResponse.informationFields.name	string	名称
価値	firmFlowReportResponse.informationFields.value	string	価値
routingSummary	firmFlowReportResponse.routingSummary	array of	routingSummary
responsibleUserOrGroups	firmFlowReportResponse.responsibleUserOrGroups	array of	responsibleUserOrGroups
FirmFlow の例外を取得する	getFirmFlowException	string	FirmFlow の例外を取得する

配送可能な FirmFlow データの取得

操作 ID:

GetFirmFlowDeliverableReport

配送可能データによる追跡レポートを取得

パラメーター

名前	キー	必須	型	説明
トークン	X-Authorization		string	トークン認証
利用可能	Accountable		string	利用可能値を入力
AssignedOn	AssignedOn		string	割り当て日を入力
AssignedTo	AssignedTo		string	割り当て先の値を入力
AssignmentHistory	AssignmentHistory		string	割り当て履歴を入力
CompletedBy	CompletedBy		string	値で完了済を入力
CompletedOn	CompletedOn		string	完了済の日を入力
CurrentDueDate	CurrentDueDate		string	現在の期日を入力
CurrentStep	CurrentStep		string	現在のステップを入力
DateExtended	DateExtended		string	延長日を入力
DaysAtStep	DaysAtStep		string	ステップで日数を入力
DaysBetweenRoutings	DaysBetweenRoutings		string	ルーティング間の日数を入力
DrawerId	DrawerId		string	ドロワー ID を入力
EngagementType	EngagementType		string	エンゲージメント タイプの入力
InProcessOnly	InProcessOnly		string	処理中のみの値を入力
インデックス	Indexes		array of string	インデックス
InformationFields	InformationFields		array of string	InformationFields
OriginalDueDate	OriginalDueDate		string	オリジナル期日を入力
PIC	PIC		string	PIC を入力
PageNumber	PageNumber		string	パージ数を入力
優先順位	Priority		string	プロパティの入力
ReceivedFrom	ReceivedFrom		string	受信元の値を入力
ReceivedOn	ReceivedOn		string	受信日を入力
責任	Responsible		string	担当者の値を入力
RoutingDetails	RoutingDetails		string	ルーティングの詳細の入力
SentOn	SentOn		string	送信日を入力
SentTo	SentTo		string	送信先の値を入力
ServiceType	ServiceType		string	サービス タイプの入力
ステータス	Status		string	ステータスの入力
TotalDaysAtStep	TotalDaysAtStep		string	ステップで合計日数を入力
TotalDaysInProcess	TotalDaysInProcess		string	合計処理日数を入力
Workflow	Workflow		string	ワークフロー名の入力
WorkflowDescription	WorkflowDescription		string	ワークフローの説明を入力

戻り値

名前	パス	型	説明
firmFlowReportResponse	firmFlowReportResponse	array of object	firmFlowReportResponse
利用可能	firmFlowReportResponse.accountable	string	利用可能値
assignedOn	firmFlowReportResponse.assignedOn	string	割り当て日
assignedTo	firmFlowReportResponse.assignedTo	string	割り当てる値
assignedToYesOrNo	firmFlowReportResponse.assignedToYesOrNo	string	ワークフローの割り当てです
assignmentHistory	firmFlowReportResponse.assignmentHistory	string	割り当て履歴の値
clientName	firmFlowReportResponse.clientName	string	クライアント名の値
clientNumber	firmFlowReportResponse.clientNumber	string	クライアントの電話番号の値
completedBy	firmFlowReportResponse.completedBy	string	値で完了済
completedOn	firmFlowReportResponse.completedOn	string	完了日
currentDueDate	firmFlowReportResponse.currentDueDate	string	現在の期日
currentStep	firmFlowReportResponse.currentStep	string	現在のステップ値
dateExtended	firmFlowReportResponse.dateExtended	string	拡張したデータ
daysAtStep	firmFlowReportResponse.daysAtStep	string	ステップでワークフローの日数
daysBetweenRoutings	firmFlowReportResponse.daysBetweenRoutings	string	ルーティング間のワークフロー日数
配送品	firmFlowReportResponse.deliverables	string	配送品の値
drawerId	firmFlowReportResponse.drawerId	string	ドロワー ID 値
eFileYesOrNo	firmFlowReportResponse.eFileYesOrNo	string	配送品は保存されます
engagementType	firmFlowReportResponse.engagementType	string	エンゲージメント タイプの値
extendedYesOrNo	firmFlowReportResponse.extendedYesOrNo	string	配送品は延長されました
informationFields	firmFlowReportResponse.informationFields	array of object	informationFields
名前	firmFlowReportResponse.informationFields.name	string	名前
値	firmFlowReportResponse.informationFields.value	string	値
originalDueDate	firmFlowReportResponse.originalDueDate	string	オリジナル期日
periodEnd	firmFlowReportResponse.periodEnd	string	期間ワークフローの終了
pic	firmFlowReportResponse.pic	string	ワークフローの写真
picYesOrNo	firmFlowReportResponse.picYesOrNo	string	写真は割り当てられました
優先度	firmFlowReportResponse.priority	string	優先順位の値
進行状況	firmFlowReportResponse.progress	string	進捗値
receivedFrom	firmFlowReportResponse.receivedFrom	string	受信元の値
receivedOn	firmFlowReportResponse.receivedOn	string	受け取り日
責任	firmFlowReportResponse.responsible	string	責任のある値
responsibleUserOrGroups	firmFlowReportResponse.responsibleUserOrGroups	array of	responsibleUserOrGroups
routingNotes	firmFlowReportResponse.routingNotes	string	ワークフローのルーティング ノート
routingSummary	firmFlowReportResponse.routingSummary	array of	routingSummary
sentOn	firmFlowReportResponse.sentOn	string	送信日
sentTo	firmFlowReportResponse.sentTo	string	送信先の値
serviceType	firmFlowReportResponse.serviceType	string	ワークフローのサービス タイプ
状態	firmFlowReportResponse.status	string	ワークフローのステータス
totalDaysAtStep	firmFlowReportResponse.totalDaysAtStep	string	ステップでワークフロー合計日数
totalDaysInProcess	firmFlowReportResponse.totalDaysInProcess	string	ワークフロー合計処理日数
ワークフロー	firmFlowReportResponse.workflow	string	ワークフロー タイプ
workflowDescription	firmFlowReportResponse.workflowDescription	string	ワークフローの説明
年	firmFlowReportResponse.year	string	ワークフローの年
getFirmFlowException	getFirmFlowException	string	FirmFlow の例外を取得
pageNumber	pageNumber	string	要求のページ数
pageSize	pageSize	integer	要求のページ サイズ
totalPages	totalPages	integer	要求ページの合計数
totalRecords	totalRecords	integer	要望の合計レコード

定義

文字列

これは基本的なデータ型 '文字列' です。

ブール値

これは基本的なデータ型 'ブール値' です。