Overview

CRM/SFAソフトウェア「ちきゅう」APIドキュメント

Version information

Version : 1.0.0

Contact information

Contact : Chikyu, Inc.

License information

Terms of service : https://chikyu.net

URI scheme

Host : api.chikyu.net
BasePath : /api/v2
Schemes : HTTP

Tags

  • advanced-security : 高度な権限機能に関するAPI

  • api-auth-key : APIキーに関するAPI

  • api-class-0 : 認証なしで呼び出し可能なAPI

  • api-class-1 : HTTPヘッダにトークンを付加することで呼び出し可能なAPI

  • api-class-2 : 事前にログインを行い、セッションを生成することで呼び出し可能なAPI

  • audit : アクセスログに関するAPI

  • contract : 契約に関するAPI

  • entity-import : CSVファイルからのデータ取り込みに関するAPI

  • entity-list : ちきゅう内に保存されたデータの取得に関するAPI

  • entity-log : データの変更ログに関するAPI

  • entity-save : ちきゅう内へのデータの保存・削除に関するAPI

  • field-definition : 項目定義に関するAPI

  • organ : 組織情報に関連するAPI

  • project : プロジェクトに関連するAPI

  • report : レポートに関連するAPI

  • search-definition : データ検索定義(リスト機能)に関するAPI

  • session : セッションに関連するAPI

  • system : システムに関するAPI

  • token : セキュリティトークンに関連するAPI

  • workflow : ワークフローに関するAPI

Consumes

  • application/json

Produces

  • application/json

Paths

POST /advanced_security/disable

Description

拡張セキュリティを無効にする

Parameters

Type Name Schema

Body

body
required

DisableAdvancedSecurityRequest

Responses

HTTP Code Schema

200

DisableAdvancedSecurityResponse

Produces

  • application/json

Tags

  • advanced-security

  • api-class-2

POST /advanced_security/enable

Description

拡張セキュリティを有効にする

Parameters

Type Name Schema

Body

body
required

EnableAdvancedSecurityRequest

Responses

HTTP Code Schema

200

EnableAdvancedSecurityResponse

Produces

  • application/json

Tags

  • advanced-security

  • api-class-2

POST /advanced_security/role/authority/list

Description

ロールの権限を取得する

Parameters

Type Name Schema

Body

body
required

GetAdvancedRoleAuthorityRequest

Responses

HTTP Code Schema

200

GetAdvancedRoleAuthorityResponse

Produces

  • application/json

Tags

  • advanced-security

  • api-class-2

POST /advanced_security/role/authority/update

Description

ロールの権限を更新する

Parameters

Type Name Schema

Body

body
required

UpdateAdvancedRoleAuthorityRequest

Responses

HTTP Code Schema

200

UpdateAdvancedRoleAuthorityResponse

Produces

  • application/json

Tags

  • advanced-security

  • api-class-2

POST /advanced_security/role/create

Description

ロールを作成する

Parameters

Type Name Schema

Body

body
required

CreateAdvancedRoleRequest

Responses

HTTP Code Schema

200

CreateAdvancedRoleResponse

Produces

  • application/json

Tags

  • advanced-security

  • api-class-2

POST /advanced_security/role/delete

Description

ロールを削除する

Parameters

Type Name Schema

Body

body
required

DeleteAdvancedRoleRequest

Responses

HTTP Code Schema

200

DeleteAdvancedRoleResponse

Produces

  • application/json

Tags

  • advanced-security

  • api-class-2

POST /advanced_security/role/document_authority/list

Description

ロールに対するコレクション内のアクセス制御一覧(ロールが保有するドキュメント毎の閲覧・編集・削除可否リスト)を取得する

Parameters

Type Name Description Schema

Body

body
required

ロールに対するコレクション内のアクセス制御一覧(ロールが保有するドキュメント毎の閲覧・編集・削除可否リスト)を取得するリクエスト

GetAdvancedRoleDocumentAuthorityRequest

Responses

HTTP Code Description Schema

200

ドキュメント毎の閲覧・編集・削除可否リスト

GetAdvancedRoleDocumentAuthorityResponse

Produces

  • application/json

Tags

  • advanced-security

  • api-class-2

POST /advanced_security/role/document_authority/update

Description

ロールに対するコレクション内のアクセス制御一覧(ロールが保有するドキュメント毎の閲覧・編集・削除可否リスト)を更新する

Parameters

Type Name Description Schema

Body

body
required

ロールに対するコレクション内のアクセス制御一覧(ロールが保有するドキュメント毎の閲覧・編集・削除可否リスト)を更新するリクエスト

UpdateAdvancedRoleDocumentAuthorityRequest

Responses

HTTP Code Description Schema

200

ロールに対するコレクション内のアクセス制御一覧(ロールが保有するドキュメント毎の閲覧・編集・削除可否リスト)を更新した結果

UpdateAdvancedRoleDocumentAuthorityResponse

Produces

  • application/json

Tags

  • advanced-security

  • api-class-2

POST /advanced_security/role/field_authority/list

Description

ロールに対するコレクションの項目毎の閲覧・編集可否リストを取得する

Parameters

Type Name Description Schema

Body

body
required

ロールに対するコレクションの項目毎の閲覧・編集可否リストを取得するリクエスト

GetAdvancedRoleFieldAuthorityRequest

Responses

HTTP Code Description Schema

200

項目毎の閲覧・編集可否リスト

GetAdvancedRoleFieldAuthorityResponse

Produces

  • application/json

Tags

  • advanced-security

  • api-class-2

POST /advanced_security/role/field_authority/update

Description

ロールに対するコレクションの項目毎の閲覧・編集可否リストを更新する

Parameters

Type Name Description Schema

Body

body
required

ロールに対するコレクションの項目毎の閲覧・編集可否リストを更新するリクエスト

UpdateAdvancedRoleFieldAuthorityRequest

Responses

HTTP Code Description Schema

200

ロールに対するコレクションの項目毎の閲覧・編集可否リストを更新した結果

UpdateAdvancedRoleFieldAuthorityResponse

Produces

  • application/json

Tags

  • advanced-security

  • api-class-2

POST /advanced_security/role/recursive

Description

ロールの階層構造を再帰的に取得する

Parameters

Type Name Schema

Body

body
required

GetAdvancedRoleRecursiveRequest

Responses

HTTP Code Schema

200

GetAdvancedRoleRecursiveResponse

Produces

  • application/json

Tags

  • advanced-security

  • api-class-2

POST /advanced_security/role/search

Description

ロールを名称でLike検索する

Parameters

Type Name Schema

Body

body
required

GetAdvancedRoleSearchRequest

Responses

HTTP Code Schema

200

GetAdvancedRoleSearchResponse

Produces

  • application/json

Tags

  • advanced-security

  • api-class-2

POST /advanced_security/role/search/with_auth

Description

追加権限のあるロールを名称でLike検索する

Parameters

Type Name Schema

Body

body
required

SearchAdvancedRoleWithAuthRequest

Responses

HTTP Code Schema

200

SearchAdvancedRoleWithAuthResponse

Produces

  • application/json

Tags

  • api-class-2

POST /advanced_security/role/update

Description

ロールを更新する

Parameters

Type Name Schema

Body

body
required

UpdateAdvancedRoleRequest

Responses

HTTP Code Schema

200

UpdateAdvancedRoleResponse

Produces

  • application/json

Tags

  • advanced-security

  • api-class-2

POST /advanced_security/role/user/add

Description

ロールに紐づくユーザーを追加する

Parameters

Type Name Schema

Body

body
required

AddAdvancedRoleUserRequest

Responses

HTTP Code Schema

200

AddAdvancedRoleUserResponse

Produces

  • application/json

Tags

  • advanced-security

  • api-class-2

POST /advanced_security/role/user/list

Description

ロールに紐づくユーザーを取得する

Parameters

Type Name Schema

Body

body
required

GetAdvancedRoleUserListRequest

Responses

HTTP Code Schema

200

GetAdvancedRoleUserListResponse

Produces

  • application/json

Tags

  • advanced-security

  • api-class-2

POST /advanced_security/role/user/remove

Description

ロールとユーザーとの紐付きを解除する

Parameters

Type Name Schema

Body

body
required

RemoveAdvancedRoleUserRequest

Responses

HTTP Code Schema

200

RemoveAdvancedRoleUserResponse

Produces

  • application/json

Tags

  • advanced-security

  • api-class-2

POST /business_cards/destination_rules_get

Description

Parameters

Type Name Description Schema

Body

body
required

[change it]

GetBusinessCardsDestinationRuleRequest

Responses

HTTP Code Description Schema

200

[change it]

GetBusinessCardsDestinationRuleResponse

Produces

  • application/json

Tags

  • api-class-2

POST /business_cards/destination_rules_update

Description

Parameters

Type Name Description Schema

Body

body
required

[change it]

UpdateBusinessCardsDestinationRuleRequest

Responses

HTTP Code Description Schema

200

[change it]

UpdateBusinessCardsDestinationRuleResponse

Produces

  • application/json

Tags

  • api-class-2

POST /business_cards/get_organ_items

Description

Parameters

Type Name Description Schema

Body

body
required

[change it]

GetBusinessCardsOrganItemsRequest

Responses

HTTP Code Description Schema

200

[change it]

GetBusinessCardsOrganItemsResponse

Produces

  • application/json

Tags

  • api-class-2

POST /entity/attached_file/single

Description

添付ファイルを1件取得する【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

添付ファイル取得要求

AttachedFileGetRequest

Responses

HTTP Code Description Schema

200

添付ファイル取得結果(リスト)

AttachedFileGetResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-list

POST /entity/business_cards/create

Description

名刺取り込み開始リクエスト。メタデータ作成しidと画像をアップロードするためのurlを返す。画像はputメソッドで後にアップロード

Parameters

Type Name Description Schema

Body

body
required

[change it]

CreateBusinessCardRequest

Responses

HTTP Code Description Schema

200

[change it]

CreateBusinessCardResponse

Produces

  • application/json

Tags

  • api-class-2

  • business-cards

POST /entity/business_cards/mapping/create

Description

Parameters

Type Name Description Schema

Body

body
required

[change it]

CreateBusinessCardFieldMappingRequest

Responses

HTTP Code Description Schema

200

[change it]

CreateBusinessCardFieldMappingResponse

Produces

  • application/json

Tags

  • api-class-2

POST /entity/business_cards/mapping/delete

Description

名刺項目マッピングを削除します

Parameters

Type Name Schema

Body

body
required

DeleteBusinessCardFieldMappingRequest

Responses

HTTP Code Schema

200

DeleteBusinessCardFieldMappingResponse

Produces

  • application/json

Tags

  • api-class-2

  • business-cards

POST /entity/business_cards/mapping/list

Description

名刺項目マッピングを全取得します

Parameters

Type Name Schema

Body

body
required

GetBusinessCardFieldMappingListRequest

Responses

HTTP Code Schema

200

GetBusinessCardFieldMappingListResponse

Produces

  • application/json

Tags

  • api-class-2

  • business-cards

POST /entity/business_cards/mapping/single

Description

名刺項目マッピングを取得します

Parameters

Type Name Schema

Body

body
required

GetBusinessCardFieldMappingRequest

Responses

HTTP Code Schema

200

GetBusinessCardFieldMappingResponse

Produces

  • application/json

Tags

  • api-class-2

  • business-cards

POST /entity/business_cards/mapping/update

Description

名刺項目マッピングを更新します

Parameters

Type Name Schema

Body

body
required

UpdateBusinessCardFieldMappingRequest

Responses

HTTP Code Schema

200

UpdateBusinessCardFieldMappingResponse

Produces

  • application/json

Tags

  • api-class-2

  • business-cards

POST /entity/business_cards/single

Description

[WIP]名刺メタデータ取得(一件)

Parameters

Type Name Description Schema

Body

body
required

[change it]

SingleBusinessCardRequest

Responses

HTTP Code Description Schema

200

[change it]

SingleBusinessCardResponse

Produces

  • application/json

Tags

  • api-class-2

  • business-cards

POST /entity/cross_search

Description

データの統合検索を実行する【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

データ取得要求

EntityCrossSearchRequest

Responses

HTTP Code Description Schema

200

データ取得結果

EntityCrossSearchResponse

Produces

  • application/json

Tags

  • api-class-1

  • entity-list

POST /entity/delete/status

Description

一括削除の処理状況を取得

Parameters

Type Name Schema

Body

body
required

StatusBatchDeleteRequest

Responses

HTTP Code Schema

200

StatusBatchDeleteResponse

Produces

  • application/json

Tags

  • api-class-1

POST /entity/field_definitions/list/all

Description

項目定義の全リストを取得する【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

項目定義取得要求

AuthorizedRequest

Responses

HTTP Code Description Schema

200

項目定義取得結果

FieldDefinitionAllListResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/import/error/list

Description

データ取り込みのエラー一覧を取得します

Parameters

Type Name Schema

Body

body
required

ListErrorImportRequest

Responses

HTTP Code Schema

200

ListErrorImportResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-import

POST /entity/import/file/column/list

Description

アップロードしたファイルのカラムリストを取得

Parameters

Type Name Schema

Body

body
required

GetColumnListRequest

Responses

HTTP Code Schema

200

GetColumnListResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-import

POST /entity/import/status

Description

インポート状況を取得する【要ログイン】 *コレクション名を指定するエンドポイントと、取得可能な結果は同一となります。

Parameters

Type Name Description Schema

Body

body
required

インポート開始要求

ImportStatusRequest

Responses

HTTP Code Description Schema

200

データ開始結果

ImportStatusResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-import

POST /entity/joined_report/rebuild/invoke

Description

結合レポートを非同期で更新する

Parameters

Type Name Schema

Body

body
required

RebuildJoinedReportRequest

Responses

HTTP Code Schema

200

RebuildJoinedReportResponse

Produces

  • application/json

Tags

  • api-class-2

POST /entity/joined_report/rebuild/status

Description

結合レポートの更新ステータスを確認する

Parameters

Type Name Schema

Body

body
required

StatusJoinedReportRequest

Responses

HTTP Code Schema

200

StatusJoinedReportResponse

Produces

  • application/json

Tags

  • api-class-2

POST /entity/merge

Description

レコードを統合します

Parameters

Type Name Schema

Body

body
required

MergeEntitiesRequest

Responses

HTTP Code Schema

200

MergeEntitiesResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-save

POST /entity/prospects/convert

Description

見込客から会社・商談・担当者を作成【ログイン】

Parameters

Type Name Description Schema

Body

body
required

見込客変換要求

ConvertProspectRequest

Responses

HTTP Code Description Schema

200

見込客変換結果

ConvertProspectResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-save

POST /entity/prospects/convert/mapping/list

Description

見込客から商談を作成する際のマッピングを取得する

Parameters

Type Name Description Schema

Body

body
required

マッピング取得要求

AuthorizedRequest

Responses

HTTP Code Description Schema

200

マッピング取得結果

ListConvertMappingResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/prospects/convert/mapping/update

Description

見込客から商談を作成する際のマッピングを更新する

Parameters

Type Name Description Schema

Body

body
required

マッピング更新要求

UpdateConvertMappingRequest

Responses

HTTP Code Description Schema

200

マッピング更新結果

Response

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/query/convert

Description

あるコレクションに対するクエリを、他のコレクションでも使えるように変換します

Parameters

Type Name Schema

Body

body
required

ConvertQueryRequest

Responses

HTTP Code Schema

200

ConvertQueryResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-list

POST /entity/query/default

Description

デフォルトの重複検索用クエリを取得します

Parameters

Type Name Schema

Body

body
required

GetDefaultQueryRequest

Responses

HTTP Code Schema

200

GetDefaultQueryResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-list

POST /entity/recent/list

Description

最近参照したデータのリストを取得

Parameters

Type Name Schema

Body

body
required

ListRecentViewEntityRequest

Responses

HTTP Code Schema

200

ListRecentViewEntityResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-list

POST /entity/search_definitions/delete

Description

検索条件を削除する【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

検索条件削除要求

SearchDefinitionDeleteRequest

Responses

HTTP Code Description Schema

200

検索条件削除結果

Response

Produces

  • application/json

Tags

  • api-class-2

  • search-definition

POST /entity/search_definitions/single

Description

データを一件取得する【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

データ取得要求

SearchDefinitionGetRequest

Responses

HTTP Code Description Schema

200

データ取得結果

SearchDefinitionGetResponse

Produces

  • application/json

Tags

  • api-class-2

  • search-definition

POST /entity/search_definitions/update

Description

検索条件を更新する【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

検索条件更新要求

SearchDefinitionUpdateRequest

Responses

HTTP Code Description Schema

200

検索条件更新結果

SearchDefinitionCreateResponse

Produces

  • application/json

Tags

  • api-class-2

  • search-definition

POST /entity/tasks/complete

Description

タスクから活動履歴を作成【ログイン】

Parameters

Type Name Description Schema

Body

body
required

タスク完了要求

CompleteTaskRequest

Responses

HTTP Code Description Schema

200

タスク完了結果

CompleteTaskResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-save

POST /entity/tasks/complete/mapping/list

Description

タスクから活動履歴を作成する際のマッピングを取得する

Parameters

Type Name Description Schema

Body

body
required

マッピング取得要求

AuthorizedRequest

Responses

HTTP Code Description Schema

200

マッピング取得結果

ListConvertMappingResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/tasks/complete/mapping/update

Description

タスクから活動履歴を作成する際のマッピングを更新する

Parameters

Type Name Description Schema

Body

body
required

マッピング更新要求

UpdateConvertMappingRequest

Responses

HTTP Code Description Schema

200

マッピング更新結果

Response

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/aggregate

Description

データを集計する【要ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ集計要求

EntityAggregateRequest

Responses

HTTP Code Description Schema

200

データ集計結果

EntityAggregateResponse

Produces

  • application/json

Tags

  • api-class-1

  • entity-list

POST /entity/{collection_name}/attached_file/create

Description

添付ファイルのメタデータを作成する【要ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

添付ファイル(メタデータ)作成要求

AttachedFileCreateRequest

Responses

HTTP Code Description Schema

200

添付ファイル(メタデータ)更新結果

AttachedFileUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-save

POST /entity/{collection_name}/attached_file/delete

Description

添付ファイルを削除する【要ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

添付ファイル(メタデータ)削除要求

AttachedFileDeleteRequest

Responses

HTTP Code Description Schema

200

添付ファイル(メタデータ)削除結果

Response

Produces

  • application/json

Tags

  • api-class-2

  • entity-save

POST /entity/{collection_name}/attached_file/list

Description

添付ファイルのリストを取得する【要ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

添付ファイル取得要求

AttachedFileListRequest

Responses

HTTP Code Description Schema

200

添付ファイル取得結果(リスト)

AttachedFileListResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-list

POST /entity/{collection_name}/attached_file/url/download

Description

添付ファイルのダウンロードURLを取得する【要ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

ダウンロードURL取得要求

AttachedFileUrlRequest

Responses

HTTP Code Description Schema

200

ダウンロードURL取得結果

AttachedFileUrlResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-list

POST /entity/{collection_name}/count

Description

データ件数を取得する【要ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ件数取得要求

EntityCountRequest

Responses

HTTP Code Description Schema

200

データ件数取得結果

EntityCountResponse

Produces

  • application/json

Tags

  • api-class-1

  • entity-list

POST /entity/{collection_name}/create

Description

データを追加する【APIキーまたはログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

EntityCreateRequest

Responses

HTTP Code Description Schema

200

データ更新結果

EntitySaveResponse

Produces

  • application/json

Tags

  • api-class-1

  • entity-save

POST /entity/{collection_name}/delete

Description

データを削除する【要ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ削除要求

EntityDeleteRequest

Responses

HTTP Code Description Schema

200

データ削除結果

EntityDeleteResponse

Produces

  • application/json

Tags

  • api-class-1

  • entity-save

POST /entity/{collection_name}/delete/batch

Description

データを削除する(バッチ)【要ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ削除要求

EntityDeleteBatchRequest

Responses

HTTP Code Description Schema

200

データ削除結果

EntityDeleteBatchResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-save

POST /entity/{collection_name}/delete/by_list

Description

データを削除する(リスト)【要ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ削除要求

EntityDeleteByListRequest

Responses

HTTP Code Description Schema

200

データ削除結果

EntityDeleteBatchResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-save

POST /entity/{collection_name}/empty

Description

データ新規作成時の雛形を取得します

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

GetInputTemplateRequest

Responses

HTTP Code Schema

200

GetInputTemplateResponse

Produces

  • application/json

Tags

  • api-class-1

  • entity-save

POST /entity/{collection_name}/field_definitions/collection/update

Description

フィールド情報を更新する(マスタ選択)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

FieldDefinitionUpdateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/date/create

Description

フィールド情報を追加する(日付)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

FieldDefinitionCreateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/date/update

Description

フィールド情報を更新する(日付)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

FieldDefinitionUpdateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/datetime/create

Description

フィールド情報を追加する(日時)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

FieldDefinitionCreateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/datetime/update

Description

フィールド情報を更新する(日時)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

FieldDefinitionUpdateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/delete

Description

フィールド情報を削除する【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ削除要求

FieldDefinitionDeleteRequest

Responses

HTTP Code Description Schema

200

データ作成結果

Response

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/disable

Description

フィールド情報を非表示にする【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ非表示要求

FieldDefinitionDisableRequest

Responses

HTTP Code Description Schema

200

データ非表示結果

Response

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/enable

Description

フィールド情報を再表示にする【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ再表示要求

FieldDefinitionEnableRequest

Responses

HTTP Code Description Schema

200

データ再表示結果

Response

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/formula/check

Description

計算式をチェックする【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

計算式チェック要求

FormulaFieldDefinitionCheckRequest

Responses

HTTP Code Description Schema

200

データチェック結果

FormulaFieldDefinitionCheckResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/formula/create

Description

フィールド情報を追加する(計算)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

FormulaFieldDefinitionCreateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/formula/update

Description

フィールド情報を更新する(計算)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

FormulaFieldDefinitionUpdateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/groups/create

Description

項目グループを作成する【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

項目グループ作成要求

FieldDefinitionGroupCreateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionGroupCreateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/groups/delete

Description

項目グループを削除する【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

項目グループ削除要求

FieldDefinitionGroupDeleteRequest

Responses

HTTP Code Description Schema

200

データ削除結果

Response

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/groups/list

Description

項目定義グループの一覧を取得する【要ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

項目定義グループ取得要求

FieldDefinitionGroupListRequest

Responses

HTTP Code Description Schema

200

項目定義グループ取得結果(リスト)

FieldDefinitionGroupListResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/groups/move

Description

項目グループを移動する

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

MoveFieldDefinitionGroupRequest

Responses

HTTP Code Schema

200

MoveFieldDefinitionGroupResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/groups/update

Description

項目グループを更新する【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

項目グループ更新要求

FieldDefinitionGroupUpdateRequest

Responses

HTTP Code Description Schema

200

データ更新結果

FieldDefinitionGroupUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/heap_aggregate/create

Description

フィールド情報を追加する(積み上げ集計)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

HeapAggregateFieldDefinitionCreateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/heap_aggregate/update

Description

フィールド情報を更新する(積み上げ集計)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

HeapAggregateFieldDefinitionUpdateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/layout_type/update

Description

フィールド情報を更新する(レイアウトタイプ)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

FieldDefinitionUpdateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/list

Description

項目定義のリストを取得する【要ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

項目定義取得要求

FieldDefinitionListRequest

Responses

HTTP Code Description Schema

200

項目定義取得結果(リスト)

FieldDefinitionListResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/lookup/create

Description

フィールド情報を追加する(ルックアップ)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

LookupFieldDefinitionCreateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/lookup/update

Description

フィールド情報を更新する(ルックアップ)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

LookupFieldDefinitionUpdateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/move

Description

フィールドの表示位置を移動する【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

項目移動要求

FieldDefinitionMoveRequest

Responses

HTTP Code Description Schema

200

データ作成結果

Response

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/multiple_select/create

Description

フィールド情報を追加する(複数選択)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

MultipleSelectFieldDefinitionCreateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/multiple_select/update

Description

フィールド情報を更新する(複数選択)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

MultipleSelectFieldDefinitionUpdateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/number/create

Description

フィールド情報を追加する(数値)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

FieldDefinitionCreateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/number/update

Description

フィールド情報を更新する(数値)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

FieldDefinitionUpdateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/organ_member/create

Description

フィールド情報を追加する(ユーザー選択型)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

FieldDefinitionCreateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/organ_member/update

Description

フィールド情報を更新する(ユーザー選択型)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

FieldDefinitionUpdateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/relations/list

Description

関連データの表示・非表示設定を取得します

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

ListOrganItemRelationsRequest

Responses

HTTP Code Schema

200

ListOrganItemRelationsResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/relations/update

Description

関連データの表示/非表示設定を更新します

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

UpdateOrganItemRelationsRequest

Responses

HTTP Code Schema

200

UpdateOrganItemRelationsResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/role/update

Description

フィールド情報を更新する(ロール)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

FieldDefinitionUpdateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/select/create

Description

フィールド情報を追加する(選択)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

SelectFieldDefinitionCreateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/select/update

Description

フィールド情報を更新する(選択)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ更新要求

SelectFieldDefinitionUpdateRequest

Responses

HTTP Code Description Schema

200

データ更新結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/string/create

Description

フィールド情報を追加する(一行テキスト)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

FieldDefinitionCreateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/string/update

Description

フィールド情報を更新する(一行テキスト)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

FieldDefinitionUpdateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/table/update

Description

フィールド情報を追加・更新する(営業担当)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

FieldDefinitionUpdateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/text/create

Description

フィールド情報を追加する(複数行テキスト)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

FieldDefinitionCreateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/field_definitions/text/update

Description

フィールド情報を更新する(複数行テキスト)【APIキー もしくは ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ作成要求

FieldDefinitionUpdateRequest

Responses

HTTP Code Description Schema

200

データ作成結果

FieldDefinitionUpdateResponse

Produces

  • application/json

Tags

  • api-class-2

  • field-definition

POST /entity/{collection_name}/import/init

Description

インポートを初期化する【要ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

インポート初期化要求

ImportInitRequest

Responses

HTTP Code Description Schema

200

データ作成結果

ImportInitResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-import

POST /entity/{collection_name}/import/start

Description

インポートを開始する【要ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

インポート開始要求

ImportStartRequest

Responses

HTTP Code Description Schema

200

インポート開始結果

ImportStartResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-import

POST /entity/{collection_name}/import/status

Description

インポート状況を取得する【要ログイン】 *コレクション名を指定しないエンドポイントと、取得可能な結果は同一となります。

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

インポート開始要求

ImportStatusRequest

Responses

HTTP Code Description Schema

200

データ開始結果

ImportStatusResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-import

POST /entity/{collection_name}/list

Description

データのリストを取得する【要ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ取得要求(リスト)

EntityListRequest

Responses

HTTP Code Description Schema

200

データ取得結果(リスト)

EntityListResponse

Produces

  • application/json

Tags

  • api-class-1

  • entity-list

POST /entity/{collection_name}/list_view/options/my_items/add_field/to_all

Description

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

AddFieldToAllUserRequest

Responses

HTTP Code Schema

200

AddFieldToAllUserResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-list

POST /entity/{collection_name}/list_view/options/my_items/current

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

GetMyItemListRequest

Responses

HTTP Code Schema

200

GetMyItemListResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-list

POST /entity/{collection_name}/list_view/options/my_items/exists/in_organ

Description

組織内で、該当のフィールドがリスト表示項目に存在しているかのチェックを行います

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

ExistsMyItemInOrganRequest

Responses

HTTP Code Schema

200

ExistsMyItemInOrganResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-list

POST /entity/{collection_name}/list_view/options/my_items/save

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

SaveMyItemListRequest

Responses

HTTP Code Description Schema

200

[change it]

SaveMyItemListResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-list

POST /entity/{collection_name}/log/list

Description

データの更新ログを取得する【要ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

変更ログ取得要求

EntityChangeLogRequest

Responses

HTTP Code Description Schema

200

変更ログ取得結果

EntityChangeLogResponse

Produces

  • application/json

Tags

  • api-class-2

  • audit

  • entity-log

POST /entity/{collection_name}/related/list

Description

関連データを取得する【要ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

関連データ取得要求

EntityRelatedItemListRequest

Responses

HTTP Code Description Schema

200

関連データ取得結果

EntityRelatedItemListResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-list

POST /entity/{collection_name}/save

Description

データを保存する【要ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ更新要求

EntitySaveRequest

Responses

HTTP Code Description Schema

200

データ更新結果

EntitySaveResponse

Produces

  • application/json

Tags

  • api-class-1

  • entity-save

POST /entity/{collection_name}/save/batch

Description

データを保存する(バッチ)【要ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ保存要求(バッチ)

EntitySaveBatchRequest

Responses

HTTP Code Description Schema

200

データ保存結果(バッチ)

EntitySaveBatchResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-save

POST /entity/{collection_name}/search_definitions/create

Description

検索条件を登録する【要ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

検索条件作成要求

SearchDefinitionCreateRequest

Responses

HTTP Code Description Schema

200

検索条件作成結果

SearchDefinitionCreateResponse

Produces

  • application/json

Tags

  • api-class-2

  • search-definition

POST /entity/{collection_name}/search_definitions/list

Description

検索条件のリストを取得する【要ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

検索条件取得要求

AuthorizedRequest

Responses

HTTP Code Description Schema

200

検索条件取得結果(リスト)

SearchDefinitionListResponse

Produces

  • application/json

Tags

  • api-class-2

  • search-definition

POST /entity/{collection_name}/search_definitions/single

Description

データを一件取得する【要ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ取得要求

SearchDefinitionGetRequest

Responses

HTTP Code Description Schema

200

データ取得結果

SearchDefinitionGetResponse

Produces

  • application/json

Tags

  • api-class-2

  • search-definition

POST /entity/{collection_name}/search_definitions/update

Description

検索条件を更新する【要ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

検索条件更新要求

SearchDefinitionUpdateRequest

Responses

HTTP Code Description Schema

200

検索条件更新結果

SearchDefinitionCreateResponse

Produces

  • application/json

Tags

  • api-class-2

  • search-definition

POST /entity/{collection_name}/single

Description

データを一件取得する【要ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ取得要求

EntityGetRequest

Responses

HTTP Code Description Schema

200

データ取得結果

EntityGetResponse

Produces

  • application/json

Tags

  • api-class-1

  • entity-list

POST /entity/{collection_name}/snapshot/single

Description

データのスナップショットを取得する【要ログイン】

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

スナップショット取得要求

EntitySnapShotRequest

Responses

HTTP Code Description Schema

200

変更ログ取得結果

EntitySnapShotResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-log

POST /entity/{collection_name}/status

Description

データの保存状況を取得

Parameters

Type Name Description Schema

Path

collection_name
required

コレクション名

string

Body

body
required

データ処理状況取得要求

EntityStatusRequest

Responses

HTTP Code Description Schema

200

データ処理状況取得結果

EntityStatusResponse

Produces

  • application/json

Tags

  • api-class-2

  • entity-save

Description

Parameters

Type Name Description Schema

Body

body
required

[change it]

TestGmailLinkRequest

Responses

HTTP Code Description Schema

200

[change it]

TestGmailLinkResponse

Produces

  • application/json

Tags

  • api-class-1

POST /gmail/tirikomi

Description

Parameters

Type Name Description Schema

Body

body
required

[change it]

GmailTorikomiRequest

Responses

HTTP Code Description Schema

200

[change it]

GmailTorikomiResponse

Produces

  • application/json

Tags

  • api-class-1

POST /project/list/all

Description

組織に存在するプロジェクト一覧を取得する【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

要求

AuthorizedRequest

Responses

HTTP Code Description Schema

200

プロジェクト情報

ProjectListResponse

Produces

  • application/json

Tags

  • api-class-2

  • project

POST /project/list/user

Description

指定したユーザーの所属するプロジェクト一覧を取得する【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

要求

ProjectListByUserRequest

Responses

HTTP Code Description Schema

200

プロジェクト情報

ProjectListResponse

Produces

  • application/json

Tags

  • api-class-2

  • project

POST /report/create/from_gadget

Description

ガジェットからレポートを作成

Parameters

Type Name Description Schema

Body

body
required

ガジェットからのレポート作成要求

ReportCreateFromGadgetRequest

Responses

HTTP Code Description Schema

200

レポートからのガジェット作成結果

ReportCreateFromGadgetResponse

Produces

  • application/json

Tags

  • api-class-2

  • report

POST /report/create/input

Description

レポート(手入力)を作成する

Parameters

Type Name Description Schema

Body

body
required

レポート作成要求

ReportCreateForInputRequest

Responses

HTTP Code Description Schema

200

レポート作成結果

ReportCreateResponse

Produces

  • application/json

Tags

  • api-class-2

  • report

POST /report/create/normal

Description

レポート(通常)を作成する

Parameters

Type Name Description Schema

Body

body
required

レポート作成要求

ReportCreateForNormalRequest

Responses

HTTP Code Description Schema

200

レポート作成結果

ReportCreateResponse

Produces

  • application/json

Tags

  • api-class-2

  • report

POST /report/data/list

Description

レポートのデータを取得

Parameters

Type Name Description Schema

Body

body
required

レポートデータ取得要求

ReportDataListRequest

Responses

HTTP Code Description Schema

200

データ処理状況取得結果

ReportDataListResponse

Produces

  • application/json

Tags

  • api-class-1

  • report

POST /report/data/preview/normal

Description

レポート(通常)をプレビューする

Parameters

Type Name Description Schema

Body

body
required

レポートプレビュー要求

ReportPreviewForNormalRequest

Responses

HTTP Code Description Schema

200

レポート更新結果

ReportDataListResponse

Produces

  • application/json

Tags

  • api-class-2

  • report

POST /report/delete

Description

レポートを削除する

Parameters

Type Name Description Schema

Body

body
required

レポート削除要求

ReportDeleteRequest

Responses

HTTP Code Description Schema

200

レポート削除結果

Response

Produces

  • application/json

Tags

  • api-class-2

  • report

POST /report/export/start

Description

レポートのエクスポートを開始する【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

レポートのエクスポート要求

StartExportRequest

Responses

HTTP Code Description Schema

200

エクスポート開始結果

StartExportResponse

Produces

  • application/json

Tags

  • api-class-2

  • report

POST /report/export/status

Description

レポートのエクスポート状況を確認する【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

状況確認リクエスト

ExportStatusRequest

Responses

HTTP Code Description Schema

200

状況確認結果

ExportStatusResponse

Produces

  • application/json

Tags

  • api-class-2

  • report

POST /report/field_definition/list

Description

レポートの項目定義を取得

Parameters

Type Name Description Schema

Body

body
required

レポートの項目定義取得要求

ReportFieldDefinitionListRequest

Responses

HTTP Code Description Schema

200

レポートの項目定義結果

ReportFieldDefinitionListResponse

Produces

  • application/json

Tags

  • api-class-2

  • report

POST /report/folder/create

Description

レポートのフォルダを作成する

Parameters

Type Name Description Schema

Body

body
required

レポートフォルダ作成要求

ReportFolderCreateRequest

Responses

HTTP Code Description Schema

200

レポートフォルダ作成結果

ReportFolderCreateResponse

Produces

  • application/json

Tags

  • api-class-2

  • report

POST /report/folder/delete

Description

レポートのフォルダを削除する

Parameters

Type Name Description Schema

Body

body
required

レポートフォルダ削除要求

ReportFolderDeleteRequest

Responses

HTTP Code Description Schema

200

レポートフォルダ削除結果

Response

Produces

  • application/json

Tags

  • api-class-2

  • report

POST /report/folder/list

Description

レポートのフォルダリストを取得する

Parameters

Type Name Description Schema

Body

body
required

レポートフォルダ取得要求

AuthorizedRequest

Responses

HTTP Code Description Schema

200

レポートフォルダ取得結果

ReportFolderListResponse

Produces

  • application/json

Tags

  • api-class-2

  • report

POST /report/folder/update

Description

レポートのフォルダを更新する

Parameters

Type Name Description Schema

Body

body
required

レポートフォルダ更新要求

ReportFolderUpdateRequest

Responses

HTTP Code Description Schema

200

レポートフォルダ更新結果

Response

Produces

  • application/json

Tags

  • api-class-2

  • report

POST /report/list

Description

レポートの一覧を取得

Parameters

Type Name Description Schema

Body

body
required

レポート一覧取得要求

ReportListRequest

Responses

HTTP Code Description Schema

200

レポート一覧取得結果

ReportListResponse

Produces

  • application/json

Tags

  • api-class-2

  • report

POST /report/single

Description

レポートを取得

Parameters

Type Name Description Schema

Body

body
required

レポート取得要求

ReportSingleRequest

Responses

HTTP Code Description Schema

200

レポート取得結果

ReportSingleResponse

Produces

  • application/json

Tags

  • api-class-2

  • report

POST /report/update/input

Description

レポート(手入力)を更新する

Parameters

Type Name Description Schema

Body

body
required

レポート更新要求

ReportUpdateForInputRequest

Responses

HTTP Code Description Schema

200

レポート更新結果

Response

Produces

  • application/json

Tags

  • api-class-2

  • report

POST /report/update/normal

Description

レポート(通常)を更新する

Parameters

Type Name Description Schema

Body

body
required

レポート更新要求

ReportUpdateForNormalRequest

Responses

HTTP Code Description Schema

200

レポート更新結果

Response

Produces

  • application/json

Tags

  • api-class-2

  • report

POST /session/exists

Description

セッションが存在するかどうかのチェックを実行する【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

処理要求

AuthorizedRequest

Responses

HTTP Code Description Schema

200

処理結果

ExistsSessionResponse

Produces

  • application/json

Tags

  • api-class-2

  • session

POST /session/login

Description

APIトークンを利用してセッションを生成する【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

APIトークン

LoginRequest

Responses

HTTP Code Description Schema

200

セッション情報

LoginResponse

Produces

  • application/json

Tags

  • api-class-0

  • session

POST /session/logout

Description

セッションを削除する【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

要求

AuthorizedRequest

Responses

HTTP Code Description Schema

200

ログアウト結果

Response

Produces

  • application/json

Tags

  • api-class-2

  • session

POST /session/organ/change

Description

処理対象の組織を変更する【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

対象組織切り替え要求

ChangeSessionOrganRequest

Responses

HTTP Code Description Schema

200

処理結果

ChangeSessionOrganResponse

Produces

  • application/json

Tags

  • api-class-2

  • session

POST /session/organ/current

Description

現在の組織を取得する【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

要求

AuthorizedRequest

Responses

HTTP Code Description Schema

200

現在の組織情報

CurrentOrganResponse

Produces

  • application/json

Tags

  • api-class-2

  • session

POST /session/organ/list

Description

選択可能な組織の一覧を取得する【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

要求

OrganListRequest

Responses

HTTP Code Description Schema

200

現在のユーザー情報

OrganListResponse

Produces

  • application/json

Tags

  • api-class-2

  • session

POST /session/organ/user/create

Description

ユーザー作成【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

要求

UserCreateRequest

Responses

HTTP Code Description Schema

200

結果

UserCreateResponse

Produces

  • application/json

Tags

  • api-class-2

  • contract

  • organ

POST /session/organ/user/delete

Description

ユーザー削除【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

要求

UserDeleteRequest

Responses

HTTP Code Description Schema

200

結果

Response

Produces

  • application/json

Tags

  • api-class-2

  • contract

  • organ

POST /session/organ/user/image/register

Description

ユーザー画像の登録【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

要求

UserImageRegisterRequest

Responses

HTTP Code Description Schema

200

結果

UserImageRegisterResponse

Produces

  • application/json

Tags

  • api-class-2

  • contract

  • organ

POST /session/organ/user/invite

Description

ユーザー招待【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

要求

UserInviteRequest

Responses

HTTP Code Description Schema

200

結果

UserInviteResponse

Produces

  • application/json

Tags

  • api-class-2

  • contract

  • organ

POST /session/organ/user/list

Description

組織に所属するユーザーのリストを取得する【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

ユーザー一覧の取得要求

UserListRequest

Responses

HTTP Code Description Schema

200

ユーザー一覧の取得結果

UserListResponse

Produces

  • application/json

Tags

  • api-class-2

  • contract

  • organ

POST /session/organ/user/single

Description

組織に所属するユーザーを取得する【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

ユーザーの取得要求

UserGetRequest

Responses

HTTP Code Description Schema

200

ユーザーの取得結果

UserGetResponse

Produces

  • application/json

Tags

  • api-class-2

  • contract

  • organ

POST /session/organ/user/update

Description

ユーザー更新【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

要求

UserUpdateRequest

Responses

HTTP Code Description Schema

200

結果

Response

Produces

  • application/json

Tags

  • api-class-2

  • contract

  • organ

POST /session/project/list

Description

所属するプロジェクト一覧を取得する【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

要求

AuthorizedRequest

Responses

HTTP Code Description Schema

200

プロジェクト情報

ProjectListResponse

Produces

  • application/json

Tags

  • api-class-2

  • session

POST /session/token/create

Description

ログイン用のAPIトークンを生成する

Parameters

Type Name Description Schema

Body

body
required

ちきゅうへのログイン情報

CreateSessionTokenRequest

Responses

HTTP Code Description Schema

200

新規作成されたトークン

CreateSessionTokenResponse

Produces

  • application/json

Tags

  • api-class-0

  • system

  • token

POST /session/token/list

Description

ログイン用のAPIトークンのリストを取得する

Parameters

Type Name Description Schema

Body

body
required

現在のトークン情報

AuthorizedRequest

Responses

HTTP Code Description Schema

200

ログイントークンのリスト

ListSessionTokenResponse

Produces

  • application/json

Tags

  • api-class-2

  • system

  • token

POST /session/token/renew

Description

ログイン用のAPIトークンを更新する

Parameters

Type Name Description Schema

Body

body
required

現在のトークン情報

TokenRequest

Responses

HTTP Code Description Schema

200

更新されたトークン

CreateSessionTokenResponse

Produces

  • application/json

Tags

  • api-class-0

  • system

  • token

POST /session/token/revoke

Description

ログイン用のAPIトークンを無効化する

Parameters

Type Name Description Schema

Body

body
required

現在のトークン情報

TokenRequest

Responses

HTTP Code Description Schema

200

削除結果

Response

Produces

  • application/json

Tags

  • api-class-2

  • system

  • token

POST /session/user

Description

現在のユーザーを取得する【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

要求

AuthorizedRequest

Responses

HTTP Code Description Schema

200

現在のユーザー情報

UserResponse

Produces

  • application/json

Tags

  • api-class-2

  • session

POST /session/user/field_authority/list

Description

ユーザーごとのロールに対するコレクションの項目毎の閲覧・編集可否リストを取得する

Parameters

Type Name Schema

Body

body
required

ListFieldAuthorityRequest

Responses

HTTP Code Schema

200

ListFieldAuthorityResponse

Produces

  • application/json

Tags

  • api-class-2

  • session

POST /session/user/image/register

Description

現在ログイン中のユーザー画像の登録【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

要求

SessionUserImageRegisterRequest

Responses

HTTP Code Description Schema

200

結果

UserImageRegisterResponse

Produces

  • application/json

Tags

  • api-class-2

  • contract

  • session

POST /session/user/reload

Description

現在のセッションに関連付けられたユーザー情報をリロードします

Parameters

Type Name Description Schema

Body

body
required

要求

AuthorizedRequest

Responses

HTTP Code Description Schema

200

現在のユーザー情報

UserResponse

Produces

  • application/json

Tags

  • api-class-2

  • session

POST /session/user/role/list

Description

ログイン中ユーザーのロール一覧を取得

Parameters

Type Name Schema

Body

body
required

AuthorizedRequest

Responses

HTTP Code Schema

200

UserRoleResponse

Produces

  • application/json

Tags

  • api-class-2

  • session

POST /session/user/update

Description

現在ログイン中のユーザー更新【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

要求

SessionUserUpdateRequest

Responses

HTTP Code Description Schema

200

結果

Response

Produces

  • application/json

Tags

  • api-class-2

  • contract

  • session

POST /system/api_auth_key/create

Description

API用 - APIキー作成【認証が必要】

Parameters

Type Name Description Schema

Body

body
required

APIキー作成要求

ApiKeyCreateRequest

Responses

HTTP Code Description Schema

200

APIキー作成結果

ApiKeyCreateResponse

Produces

  • application/json

Tags

  • api-auth-key

  • api-class-2

  • system

POST /system/api_auth_key/for_user/create/accept

Description

ユーザー向けAPIキー作成

Parameters

Type Name Description Schema

Body

body
required

APIキー作成要求

ApiKeyCreateAcceptForUserRequest

Responses

HTTP Code Description Schema

200

APIキー作成結果

ApiKeyCreateAcceptForUserResponse

Produces

  • application/json

Tags

  • api-auth-key

  • api-class-0

  • system

POST /system/api_auth_key/for_user/create/request

Description

ユーザー向けAPIキー要求

Parameters

Type Name Description Schema

Body

body
required

APIキー作成要求

ApiKeyCreateRequestForUserRequest

Responses

HTTP Code Description Schema

200

APIキー作成結果

ApiKeyCreateRequestForUserResponse

Produces

  • application/json

Tags

  • api-auth-key

  • api-class-0

  • system

POST /system/api_auth_key/list

Description

API用 - APIキー一覧取得【認証が必要】

Parameters

Type Name Description Schema

Body

body
required

APIキー作成要求

AuthorizedRequest

Responses

HTTP Code Description Schema

200

APIキー作成結果

ApiKeyListResponse

Produces

  • application/json

Tags

  • api-auth-key

  • api-class-2

  • system

POST /system/api_auth_key/revoke

Description

API用 - APIキー削除【認証が必要】

Parameters

Type Name Description Schema

Body

body
required

APIキー削除要求

ApiKeyDeleteRequest

Responses

HTTP Code Description Schema

200

APIキー削除結果

Response

Produces

  • application/json

Tags

  • api-auth-key

  • api-class-2

  • system

POST /system/audit/log/archive

Description

監査ログを取得【要ログイン】

Parameters

Type Name Description Schema

Body

body
required

監査ログ取得要求

AuditLogGetArchiveRequest

Responses

HTTP Code Description Schema

200

監査ログ取得結果

AuditLogGetArchiveResponse

Produces

  • application/json

Tags

  • api-class-2

  • audit

POST /workflow/text

Description

ワークフローによるテキストのレンダリングテスト【内部用】

Parameters

Type Name Description Schema

Body

body
required

ワークフローテキスト作成要求

WorkflowTextRequest

Responses

HTTP Code Description Schema

200

処理結果

WorkflowTextResponse

Produces

  • application/json

Tags

  • api-class-2

  • workflow

Definitions

AbilityModel

この操作の可否(is_enabled_for_this, is_enabled_for_ancestors ともに true なら可、それ以外は不可)

Name Description Schema

is_enabled_for_ancestors
required

祖先ロールにおけるこの操作の可否

boolean

is_enabled_for_this
required

このロールにおけるこの操作の可否

boolean

AddAdvancedRoleUserRequest

Polymorphism : Composition

Name Description Schema

data
required

AddAdvancedRoleUserRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

AddAdvancedRoleUserRequestModel

ロールに紐づくユーザーを追加するリクエスト

Name Description Schema

role_object_id
required

ユーザーを追加するロールのObjectID

string

user_id
required

ロールに追加するユーザーのID

integer

AddAdvancedRoleUserResponse

Polymorphism : Composition

Name Description Schema

data
optional

AddAdvancedRoleUserResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

AddAdvancedRoleUserResponseModel

ロールに紐づくユーザーを追加した結果

Type : object

AddFieldToAllUserRequest

Polymorphism : Composition

Name Description Schema

data
required

AddFieldToAllUserRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

AddFieldToAllUserRequestModel

Name Description Schema

field_name
required

フィールド名称

string

AddFieldToAllUserResponse

Polymorphism : Composition

Name Description Schema

data
optional

AddFieldToAllUserResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

AddFieldToAllUserResponseModel

Type : object

AdvancedRoleDocumentAuthorityModel

アクセス制御(ロールが保有するドキュメント毎の閲覧・編集・削除・追加可否)

Name Description Schema

access_control_range
required

reference_role_object_id を基準としたアクセス制御の範囲

string

is_addable
required

追加可否

boolean

is_deletable
required

削除可否

boolean

is_editable
required

編集可否

boolean

is_visible
required

閲覧可否

boolean

reference_role_object_id
required

アクセス制御範囲の基準となるロールのObjectID

string

AdvancedRoleModel

Name Description Schema

_id
required

ObjectID

string

description
required

ロールの説明

string

key
required

ロールを一意に特定するキー

string

name
required

名称

string

AdvancedRoleTreeModel

Name Description Schema

children
optional

子ロールの一覧 (Swagger では再帰的構造が定義できないので、あくまでも一例)

< children > array

role
optional

AdvancedRoleModel

children

Name Description Schema

children
optional

< AdvancedRoleTreeModel > array

has_fetched_children
optional

子ロールを取得済みかどうか

boolean

role
optional

AdvancedRoleModel

AggregationGroupModel

集計グループ

Name Description Schema

field_name
required

グルーピング対象フィールド名

string

grouping_type
required

データ型に応じた分類方法 日付->  year = 年  quarter = 四半期  month = 月  week = 週  day = 日  hour = 時  minute = 分 その他->  normal = 実値

string

AggregationResultModel

データ集計結果

Name Description Schema

series_field_list
optional

系列に含まれるフィールド情報

< series_field_list > array

series_name
optional

系列名

string

values
optional

< values > array

series_field_list

Name Description Schema

display_name
optional

フィールド表示名称

string

field_display_value
optional

フィールド表示値

string

field_name
optional

フィールド名

string

field_value
optional

フィールド値

string

values

Name Description Schema

field_name
optional

集計フィールド名

string

value
optional

集計値

number

AggregationTargetModel

集計方法

Name Description Schema

aggregation_type
required

集計方法  sum = 合計  avg = 平均  min = 最小  max = 最大

string

field_name
required

集計対象フィールド名(件数を取得する場合は「count」と指定)

string

AndConditionListModel

抽出条件リスト(AND条件)

Type : < OrConditionListModel > array

ApiKeyCreateAcceptForUserRequest

Name Schema

data
required

ApiKeyCreateAcceptForUserRequestModel

ApiKeyCreateAcceptForUserRequestModel

Name Description Schema

create_accept_key
optional

キー生成の認可キー

string

organ_id
optional

組織ID

integer

role_id
optional

関連するロールのID

string

ApiKeyCreateAcceptForUserResponse

Polymorphism : Composition

Name Description Schema

data
optional

ApiKeyCreateAcceptForUserResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

ApiKeyCreateAcceptForUserResponseModel

Name Description Schema

_id
required

APIキーに割り振られた一意のID

string

api_key
required

API認証キー(*1組織ごとに1つとなります)

string

auth_key
required

API認可キー

string

ApiKeyCreateRequest

Polymorphism : Composition

Name Description Schema

data
required

ApiKeyCreateRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

ApiKeyCreateRequestForUserRequest

Name Schema

data
required

ApiKeyCreateRequestForUserRequestModel

ApiKeyCreateRequestForUserRequestModel

Name Description Schema

login_secret_token
required

login secret token

string

login_token
required

login token

string

token_name
required

token name

string

ApiKeyCreateRequestForUserResponse

Polymorphism : Composition

Name Description Schema

data
optional

ApiKeyCreateRequestForUserResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

ApiKeyCreateRequestForUserResponseModel

Name Description Schema

create_accept_key
optional

APIキー生成の認可キー

string

display_name
optional

ユーザー名

string

email
optional

メールアドレス

string

organs
optional

< organs > array

user_id
optional

ユーザーID

integer

organs

Name Description Schema

organ_id
optional

組織ID

integer

organ_name
optional

組織名

string

role_list
optional

< role_list > array

role_list

Name Description Schema

is_default
optional

デフォルトの場合は1

integer

role_id
optional

ロールID

integer

role_name
optional

ロール名称

string

ApiKeyCreateRequestModel

Name Description Schema

allowed_hosts
optional

アクセス可能なIPアドレスのリスト(空白の場合は制限なし)

< string > array

api_key_name
required

APIキー名称

string

role_id
optional

関連付けるロールのID

string

ApiKeyCreateResponse

Polymorphism : Composition

Name Description Schema

data
optional

ApiKeyCreateResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

ApiKeyCreateResponseModel

Name Description Schema

_id
required

APIキーに割り振られた一意のID

string

api_key
required

API認証キー(*1組織ごとに1つとなります)

string

auth_key
required

API認可キー

string

ApiKeyDeleteRequest

Polymorphism : Composition

Name Description Schema

data
required

ApiKeyDeleteRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

ApiKeyDeleteRequestModel

Name Description Schema

_id
required

削除対象となるAPIキーのID

string

ApiKeyListResponse

Polymorphism : Composition

Name Description Schema

data
optional

ApiKeyListResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

ApiKeyListResponseModel

Type : < ApiKeyListResponseModel > array

ApiKeyListResponseModel

Name Description Schema

_id
required

APIキーごとの一意のID

string

api_key_name
optional

APIキーの名称

string

AttachedFileCreateRequest

Polymorphism : Composition

Name Description Schema

data
required

AttachedFileCreateRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

AttachedFileCreateRequestModel

添付ファイル(メタデータ)作成要求

Name Description Schema

file_name
required

添付ファイル名

string

is_secure
optional

パブリックアクセス可能とする場合にfalse(指定しなければ、パブリックアクセス不可)

boolean

target_item_id
required

関連付け先となるデータのID

string

AttachedFileCreateResponseModel

添付ファイル(メタデータ)更新結果

Polymorphism : Composition

Name Description Schema

_id
optional

対象データのID

string

content_type
optional

アップロードの際に指定するcontent_type

string

method
optional

許可されるhttpメソッド

string

url
optional

アップロード/ダウンロードなどのアクションを実行する対象URL

string

AttachedFileDeleteRequest

Polymorphism : Composition

Name Description Schema

data
required

AttachedFileDeleteRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

AttachedFileDeleteRequestModel

添付ファイル(メタデータ)削除要求

Name Description Schema

_id
required

対象データのID

string

AttachedFileGetRequest

Polymorphism : Composition

Name Description Schema

data
required

data

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

data

Name Description Schema

_id
required

対象データのID

string

AttachedFileGetResponse

Polymorphism : Composition

Name Description Schema

_id
required

データのID

string

created_by
optional

作成者

string

created_by_name
optional

作成者名

string

created_on
optional

作成日

string

download_url
optional

ファイルのダウンロードURL(publicであるもののみ)

string

file_name
required

添付ファイル名

string

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

AttachedFileListRequest

Polymorphism : Composition

Name Description Schema

data
required

AttachedFileListRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

AttachedFileListRequestModel

Polymorphism : Composition

Name Description Schema

condition_list
optional

AndConditionListModel

items_per_page
required

ページごとのデータ取得件数

integer

page_index
required

取得ページ番号

integer

sort
optional

SortListModel

target_item_id
optional

添付ファイルの取得対象となる関連データのID

string

AttachedFileListResponse

Polymorphism : Composition

Name Description Schema

data
optional

AttachedFileListResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

AttachedFileListResponseModel

Polymorphism : Composition

Name Description Schema

is_last_page
optional

最終ページである場合にtrue

boolean

last_index
optional

最後のデータのindex

integer

list
optional

< AttachedFileModel > array

page_count
optional

ページ数

integer

page_index
optional

現在のページ番号

integer

page_item_count
optional

ページ内の件数

integer

start_index
optional

最初のデータのindex

integer

total_count
optional

総件数

integer

AttachedFileModel

添付ファイルデータ

Name Description Schema

_id
required

データのID

string

created_by
optional

作成者

string

created_by_name
optional

作成者名

string

created_on
optional

作成日

string

download_url
optional

ファイルのダウンロードURL(publicであるもののみ)

string

file_name
required

添付ファイル名

string

AttachedFileUpdateResponse

Polymorphism : Composition

Name Description Schema

data
optional

AttachedFileCreateResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

AttachedFileUrlRequest

Polymorphism : Composition

Name Description Schema

data
required

AttachedFileUrlRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

AttachedFileUrlRequestModel

添付ファイルのURL生成要求

Name Description Schema

_id
required

対象データのID

string

AttachedFileUrlResponse

Polymorphism : Composition

Name Description Schema

data
optional

AttachedFileUrlResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

AttachedFileUrlResponseModel

添付ファイルのURL生成結果

Name Description Schema

method
optional

許可されるhttpメソッド

string

url
optional

アップロード/ダウンロードなどのアクションを実行する対象URL

string

AuditLogGetArchiveRequest

Polymorphism : Composition

Name Description Schema

data
required

AuditLogGetArchiveRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

AuditLogGetArchiveRequestModel

Name Description Schema

end_before
optional

ログの取得を終了する日時をunix timeで指定(最大50000件まで取得)

integer

start_after
optional

ログの取得を開始する日時をunix timeで指定(最大50000件まで取得)

integer

AuditLogGetArchiveResponse

Polymorphism : Composition

Name Description Schema

data
optional

AuditLogGetArchiveResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

AuditLogGetArchiveResponseModel

Name Description Schema

download_url
optional

ファイルのダウンロードURL(180秒間有効)

string

AuthorityModel

Name Description Schema

action
required

権限の対象となる操作名

string

name
required

権限名

string

target
required

権限の設定対象名

string

AuthorizedRequest

Polymorphism : Composition

Name Description Schema

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

BusinessCardFieldMappingModel

名刺項目マッピング

Name Description Schema

dst_collection_name
required

変換先コレクション名

string

mapping
required

名刺と変換先コレクション間の項目マッピング。{名刺の項目:変換先コレクションの項目}

< string, string > map

BusinessCardModel

名刺データ

Name Description Schema

_id
required

ID

string

address
optional

住所

string

back_image_url
optional

裏面画像のURL

string

business_card_process_status
required

取り込み状況 chikyu.business_cards.helperのBusinessCardsStatusに記述のどれか

string

company_name
optional

会社名

string

division_name
optional

役職

string

email
optional

emailアドレス

string

fax_number
optional

FAX

string

first_name
optional

string

front_image_url
optional

表面画像のURL

string

last_name
optional

string

phone_number
optional

電話番号

string

thumbnail_url
optional

サムネイル画像のURL

string

title_name
optional

役職

string

zip_code
optional

郵便番号

string

ChangeSessionOrganRequest

Polymorphism : Composition

Name Description Schema

data
required

ChangeSessionOrganRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

ChangeSessionOrganRequestModel

処理対象の組織IDを変更

Name Description Schema

target_organ_id
required

処理対象の組織ID

integer

ChangeSessionOrganResponse

Polymorphism : Composition

Name Description Schema

data
optional

ChangeSessionOrganResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

ChangeSessionOrganResponseModel

処理対象の組織IDを変更

Name Description Schema

api_key
required

組織ごとのAPIキー

string

user
optional

UserModel

CompleteTaskRequest

Polymorphism : Composition

Name Description Schema

data
required

CompleteTaskRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

CompleteTaskRequestModel

タスク完了要求

Name Description Schema

_id
required

変換対象データのID

string

CompleteTaskResponse

Polymorphism : Composition

Name Description Schema

data
optional

CompleteTaskResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

CompleteTaskResponseModel

タスク完了要求

Name Description Schema

activity_history_id
optional

変換された活動履歴のID

string

ConditionModel

条件設定オブジェクト

Name Description Schema

collection_name
optional

対象となるコレクション名(レポートでの利用以外の場合は常に空白)

string

field_name
required

対象フィールド名 「KEYWORD」と指定すると、全フィールドからキーワード検索を行う。 *その場合はoperatorが無視され、「含む」で固定となる。

string

operator
required

日付・日時型以外に対して検索を行う場合の演算子 cn=含む eq=等しい bw=で始まる ew=で終わる nc=含まない ne=等しくない bn=で始まらない en=で終わらない gt=より大きい ge=と等しいか大きい lt=より小さい le=と等しいか小さい between=の間 na=空白である cs=空白でない

string

range_option
optional

日付(date)・日時型(datetime)型に対してのみ有効。 検索を行う場合の演算子。 custom=始まりの日(value)と終わりの日(range_to_value)を指定 today=今日 yesterday=昨日 tomorrow=明日 this_week=今週 last_week=先週 next_week=来週 this_month=今月 last_month=先月 next_month=来月 this_quarter=当四半期 last_quarter=前四半期 next_quarter=翌四半期 this_year=本年 last_year=昨年 next_year=来年 this_fiscal_year=当会計年度 last_fiscal_year=前会計年度 next_fiscal_year=翌会計年度 past7days=過去7日間 past14days=過去14日間 past30days=過去30日間 not_applicable=空白である CONTAINS=空白でない

string

range_to_value
optional

範囲を指定する場合の最大値

string

search_type
optional

データ型が「collection」または「table」である場合のみ有効。 value=表示値で検索(デフォルト) id=idで検索

string

value
required

フィールド値(範囲指定の場合は最小値)

string

ConvertMappingMappableFieldListModel

データ変換元に対し、マッピング可能なフィールドのリスト

Name Description Schema

items
required

< FieldDefinitionModel > array

type
required

データ型

string

ConvertMappingModel

データ変換定義

Name Description Schema

destinations
required

データ変換先コレクションの定義

< ConvertMappingTargetModel > array

source
required

データ変換元コレクションの定義

source

source

Name Description Schema

collection_label
required

変換先コレクション名の表示名称

string

collection_name
required

変換元のコレクション名

string

field_definitions
required

< FieldDefinitionModel > array

ConvertMappingTargetFieldModel

フィールド変換の項目定義

Name Description Schema

dst_field_display_name
optional

変換先フィールドの表示名称

string

dst_field_id
optional

変換先フィールドのID

string

dst_field_name
optional

変換先フィールドのフィールド名

string

editable
optional

変換のマッピングが変更可能である場合はtrue

boolean

src_field_display_name
required

変換元フィールドの表示名称

string

src_field_id
required

変換元フィールドのID

string

src_field_name
required

変換元フィールドのフィールド名

string

ConvertMappingTargetModel

データ変換のマッピング先コレクションの定義

Name Description Schema

collection_label
required

変換先コレクション名の表示名称

string

collection_name
required

変換先のコレクション名

string

mappable_items
optional

< ConvertMappingMappableFieldListModel > array

mappings
required

< ConvertMappingTargetFieldModel > array

ConvertMappingUpdateFieldModel

フィールド変換の更新リクエスト

Name Description Schema

dest_field_id
optional

変換先フィールドのフィールド名(空白を指定した場合、マッピングしない設定となります)

string

src_field_id
required

変換元フィールドのフィールド名

string

ConvertMappingUpdateModel

データ変換のマッピングを更新します。

Name Description Schema

collection_name
required

変換先のコレクション名

string

mappings
required

< ConvertMappingUpdateFieldModel > array

ConvertProspectRequest

Polymorphism : Composition

Name Description Schema

data
required

ConvertProspectRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

ConvertProspectRequestModel

見込客変換要求

Name Description Schema

_id
required

変換対象データのID

string

business_discussion_layout_type_id
optional

新規作成される商談のレイアウトタイプID(レイアウトタイプを利用する場合のみ)

string

company_layout_type_id
optional

新規作成される会社のレイアウトタイプID(レイアウトタイプを利用する場合のみ)

string

customer_layout_type_id
optional

新規作成される担当者のレイアウトタイプID(レイアウトタイプを利用する場合のみ)

string

is_create_business_discussion
optional

変換時に商談を作成する(1=作成する, 0=作成しない)

integer

is_create_company
optional

変換時に会社を作成する(1=作成する, 0=作成しない)

integer

is_override_sales_staff
optional

変換時に営業担当を関連付け直す(1=関連付け直す, 0=見込客のものをそのまま利用する)

integer

sales_staff_id
optional

関連付け直す対象となる営業担当のユーザーID

integer

target_company_id
optional

関連付ける会社のID(変換時に会社を作成しない場合)

string

target_situation_div_key
optional

商談作成時に指定する商談状況のキー値

integer

ConvertProspectResponse

Polymorphism : Composition

Name Description Schema

data
optional

ConvertProspectResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

ConvertProspectResponseModel

見込客変換結果

Name Description Schema

business_discussion_id
optional

作成された商談ID

string

company_id
optional

作成された会社ID

string

customer_id
optional

作成された担当者ID

string

ConvertQueryRequest

Polymorphism : Composition

Name Description Schema

data
required

ConvertQueryRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

ConvertQueryRequestModel

あるコレクションに対するクエリを他のコレクションに対して使えるように変換するリクエスト

Name Description Schema

collection_name_from
required

変換前クエリの対象となるコレクション

string

collection_name_to
required

変換後クエリの対象となるコレクション

string

condition_list
required

AndConditionListModel

ConvertQueryResponse

Polymorphism : Composition

Name Description Schema

data
optional

ConvertQueryResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

ConvertQueryResponseModel

あるコレクションに対するクエリを他のコレクションに対して使えるように変換する処理のレスポンス

Name Schema

condition_list
required

AndConditionListModel

CreateAdvancedRoleRequest

Polymorphism : Composition

Name Description Schema

data
required

CreateAdvancedRoleRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

CreateAdvancedRoleRequestModel

ロール作成リクエスト

Name Description Schema

parent_role_object_id
required

作成するロールに紐付ける親ロールのObjectID

string

role_description
required

ロールの説明

string

role_key
required

作成するロールのキー

string

role_name
required

作成するロールの名称

string

CreateAdvancedRoleResponse

Polymorphism : Composition

Name Description Schema

data
optional

CreateAdvancedRoleResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

CreateAdvancedRoleResponseModel

ロール作成結果

Name Description Schema

role_object_id
required

作成したロールのObjectID

string

CreateBusinessCardFieldMappingRequest

Polymorphism : Composition

Name Description Schema

data
required

CreateBusinessCardFieldMappingRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

CreateBusinessCardFieldMappingRequestModel

Name Description Schema

dst_collection_name
required

変換先コレクション名

string

mapping
required

名刺と変換先コレクション間の項目マッピング。{名刺の項目:変換先コレクションの項目}

< string, string > map

CreateBusinessCardFieldMappingResponse

Polymorphism : Composition

Name Description Schema

data
optional

CreateBusinessCardFieldMappingResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

CreateBusinessCardFieldMappingResponseModel

名刺項目マッピング作成結果

Type : object

CreateBusinessCardRequest

Polymorphism : Composition

Name Description Schema

data
required

CreateBusinessCardRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

CreateBusinessCardRequestModel

Name Description Schema

destination_rule_name
optional

振り分けルールの識別子

string

has_card_back
optional

名刺裏面の画像を送信するかどうか

boolean

CreateBusinessCardResponse

Polymorphism : Composition

Name Description Schema

data
optional

CreateBusinessCardResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

CreateBusinessCardResponseModel

名刺画像のアップロード先

Name Description Schema

_id
required

名刺レコードid

string

back_image_put_url
optional

名刺画像裏面put先url

string

content_type
required

content-type

string

front_image_put_url
required

名刺画像おもて面put先url

string

method
required

HTTPメソッド名

string

CreateSessionTokenRequest

Name Schema

data
required

CreateSessionTokenRequestModel

CreateSessionTokenRequestModel

Name Description Schema

duration
optional

トークンを有効とする秒数 ・「0」を指定した場合は無期限 ・デフォルトは86400秒(24時間)

integer

email
required

ログイン用メールアドレス

string

password
required

ログイン用パスワード

string

token_name
required

トークンの名称(任意の名前)

string

CreateSessionTokenResponse

Polymorphism : Composition

Name Description Schema

data
optional

CreteSessionTokenResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

CreteSessionTokenResponseModel

ログイントークン

Name Description Schema

login_secret_token
optional

ログイントークン(2)

string

login_token
optional

ログイントークン(1)

string

CurrentOrganResponse

Polymorphism : Composition

Name Description Schema

data
optional

OrganModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

DeleteAdvancedRoleRequest

Polymorphism : Composition

Name Description Schema

data
required

DeleteAdvancedRoleRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

DeleteAdvancedRoleRequestModel

ロール削除リクエスト

Name Description Schema

role_object_id
required

削除するロールのObjectID

string

DeleteAdvancedRoleResponse

Polymorphism : Composition

Name Description Schema

data
optional

DeleteAdvancedRoleResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

DeleteAdvancedRoleResponseModel

ロール削除結果

Name Description Schema

destination_role_object_id
required

削除されたロールに紐づく案件等が新たに紐付いたロール(現状は親ロール)のObjectID

string

DeleteBusinessCardFieldMappingRequest

Polymorphism : Composition

Name Description Schema

data
required

DeleteBusinessCardFieldMappingRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

DeleteBusinessCardFieldMappingRequestModel

名刺項目マッピング削除リクエスト

Name Description Schema

dst_collection_name
required

変換先コレクション名

string

DeleteBusinessCardFieldMappingResponse

Polymorphism : Composition

Name Description Schema

data
optional

DeleteBusinessCardFieldMappingResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

DeleteBusinessCardFieldMappingResponseModel

名刺項目マッピング削除結果

Type : object

DisableAdvancedSecurityRequest

Polymorphism : Composition

Name Description Schema

data
required

DisableAdvancedSecurityRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

DisableAdvancedSecurityRequestModel

拡張セキュリティを無効にするリクエスト

Type : object

DisableAdvancedSecurityResponse

Polymorphism : Composition

Name Description Schema

data
optional

DisableAdvancedSecurityResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

DisableAdvancedSecurityResponseModel

拡張セキュリティを無効にする処理のレスポンス

Type : object

DuplicateGadgetRequest

Polymorphism : Composition

Name Description Schema

data
required

DuplicateGadgetRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

DuplicateGadgetRequestModel

Name Description Schema

gadget_id
required

ID

integer

gadget_name
optional

新しく複製されるガジェットの名前

string

project_id
optional

複製先のプロジェクト。マイキャンバスに複製する場合は0を指定する

integer

DuplicateGadgetResponse

Polymorphism : Composition

Name Description Schema

data
optional

DuplicateGadgetResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

DuplicateGadgetResponseModel

Name Description Schema

gadget_id
required

新しく複製されたガジェットのid

integer

EnableAdvancedSecurityRequest

Polymorphism : Composition

Name Description Schema

data
required

EnableAdvancedSecurityRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

EnableAdvancedSecurityRequestModel

拡張セキュリティを有効にするリクエスト

Type : object

EnableAdvancedSecurityResponse

Polymorphism : Composition

Name Description Schema

data
optional

EnableAdvancedSecurityResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

EnableAdvancedSecurityResponseModel

拡張セキュリティを有効にする処理のレスポンス

Type : object

EntityAggregateRequest

Polymorphism : Composition

Name Description Schema

data
optional

EntityAggregateRequestModel

session_id
optional

セッションID(HTTPヘッダにAPIキーを付加している場合は不要)

string

EntityAggregateRequestModel

データ集計要求

Name Description Schema

condition_list
optional

AndConditionListModel

group_list
required

グループ条件リスト

< AggregationGroupModel > array

list_id
optional

検索に利用するリストのID

string

target_list
required

集計対象リスト

< AggregationTargetModel > array

EntityAggregateResponse

Polymorphism : Composition

Name Description Schema

data
optional

EntityAggregateResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

EntityAggregateResponseModel

データ集計結果

Name Schema

aggregation_result
optional

< AggregationResultModel > array

EntityChangeLogModel

ログ取得結果

Name Description Schema

collection_name
optional

コレクション名

string

created_by
optional

変更者のユーザーID

string

created_on
optional

変更日時

string

diff_list
optional

< diff_list > array

entity_id
optional

対象データのID

string

item_action
optional

データ変更タイプ

string

log_id
optional

ログのID

string

organ_id
optional

組織ID

integer

source_ip_address
optional

アクセス元のIPアドレス

string

diff_list

Name Description Schema

field_name
optional

フィールド名称

string

new_value
optional

更新後の値

string

old_vale
optional

更新前の値

string

EntityChangeLogRequest

Polymorphism : Composition

Name Description Schema

data
optional

EntityChangeLogRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

EntityChangeLogRequestModel

ログ取得要求

Name Description Schema

_id
required

対象データのID

string

EntityChangeLogResponse

Polymorphism : Composition

Name Description Schema

data
optional

< EntityChangeLogModel > array

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

EntityCountRequest

Polymorphism : Composition

Name Description Schema

data
optional

EntityCountRequestModel

session_id
optional

セッションID(HTTPヘッダにAPIキーを付加している場合は不要)

string

EntityCountRequestModel

Name Description Schema

condition_list
optional

AndConditionListModel

list_id
optional

検索に利用するリストのID

string

search_field_name
optional

検索フィールド名(ALL_FIELDSを指定すると、全項目から検索)

string

search_field_value
optional

検索フィールド値

string

EntityCountResponse

Polymorphism : Composition

Name Description Schema

data
optional

EntityCountResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

EntityCountResponseModel

Name Description Schema

total_count
optional

総件数

integer

EntityCreateRequest

Polymorphism : Composition

Name Description Schema

data
required

EntityCreateRequestModel

session_id
optional

セッションID(HTTPヘッダにAPIキーを付加している場合は不要)

string

EntityCreateRequestModel

Name Description Schema

fields
required

項目設定で定義されたフィールド名と、対応する値のマップ

object

is_async
optional

処理を非同期で実行する(空白の場合はfalse)

boolean

options
optional

該当項目の検索定義(データが検索された場合はエラー)

EntitySearchOptionsModel

EntityCrossSearchRequest

Polymorphism : Composition

Name Description Schema

data
optional

EntityCrossSearchRequestModel

session_id
optional

セッションID(HTTPヘッダにAPIキーを付加している場合は不要)

string

EntityCrossSearchRequestModel

Name Description Schema

ignore_fields
optional

< string > array

items_per_page
required

ページごとのデータ取得件数

integer

keyword
required

キーワード

string

page_index
required

取得ページ番号

integer

target_collection_names
optional

< string > array

EntityCrossSearchResponse

Polymorphism : Composition

Name Description Schema

data
optional

EntityCrossSearchResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

EntityCrossSearchResponseItemModel

Name Description Schema

collection_display_name
optional

コレクション表示名

string

collection_name
optional

コレクション名

string

item_list
optional

データリスト

< object > array

total_count
optional

総データ件数

integer

EntityCrossSearchResponseModel

EntityDeleteBatchRequest

Polymorphism : Composition

Name Description Schema

data
required

EntityDeleteBatchRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

EntityDeleteBatchRequestModel

Type : < EntityDeleteRequestModel > array

EntityDeleteBatchResponse

Polymorphism : Composition

Name Description Schema

data
optional

EntityDeleteBatchResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

EntityDeleteBatchResponseModel

一括削除結果

Name Description Schema

delete_id
optional

削除ジョブの実行ID

string

EntityDeleteByListRequest

Polymorphism : Composition

Name Description Schema

data
required

EntityDeleteByListRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

EntityDeleteByListRequestModel

Name Description Schema

expected_delete_count
optional

削除予想件数(空白であればチェックしない)

integer

is_force
optional

既に同じリストで削除中であっても実行する場合はtrue

boolean

list_id
required

削除対象とするリストのID

string

EntityDeleteRequest

Polymorphism : Composition

Name Description Schema

data
required

EntityDeleteRequestModel

session_id
optional

セッションID(HTTPヘッダにAPIキーを付加している場合は不要)

string

EntityDeleteRequestModel

Name Description Schema

key
required

取得対象データのキー(キーの内容はオプションに準ずる。オプションを指定しない場合はid)

string

key_search_option
optional

KeySearchOptionModel

EntityDeleteResponse

Polymorphism : Composition

Name Description Schema

data
optional

EntityDeleteResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

EntityDeleteResponseModel

一括削除結果

Name Description Schema

delete_id
optional

削除ジョブの実行ID

string

EntityGetRequest

Polymorphism : Composition

Name Description Schema

data
required

EntityGetRequestModel

session_id
optional

セッションID(HTTPヘッダにAPIキーを付加している場合は不要)

string

EntityGetRequestModel

単一データ取得要求

Name Description Schema

key
required

取得対象データのキー(キーの内容はオプションに準ずる。オプションを指定しない場合はid)

string

key_search_option
optional

KeySearchOptionModel

EntityGetResponse

Polymorphism : Composition

Name Description Schema

data
optional

EntityModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

EntityListRequest

Polymorphism : Composition

Name Description Schema

data
required

EntityListRequestModel

session_id
optional

セッションID(HTTPヘッダにAPIキーを付加している場合は不要)

string

EntityListRequestModel

Polymorphism : Composition

Name Description Schema

condition_list
optional

AndConditionListModel

items_per_page
required

ページごとのデータ取得件数

integer

list_id
optional

検索に利用するリストのID

string

page_index
required

取得ページ番号

integer

search_field_name
optional

検索フィールド名(ALL_FIELDSを指定すると、全項目から検索)

string

search_field_value
optional

検索フィールド値

string

sort
optional

SortListModel

EntityListResponse

Polymorphism : Composition

Name Description Schema

data
optional

EntityListResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

EntityListResponseModel

データ取得結果

Polymorphism : Composition

Name Description Schema

is_last_page
optional

最終ページである場合にtrue

boolean

last_index
optional

最後のデータのindex

integer

list
optional

< EntityModel > array

page_count
optional

ページ数

integer

page_index
optional

現在のページ番号

integer

page_item_count
optional

ページ内の件数

integer

start_index
optional

最初のデータのindex

integer

total_count
optional

総件数

integer

EntityModel

取得データ(取得対象フィールドは項目設定に準ずる)

Name Description Schema

display_name
optional__

表示名称

string

_id
optional

取得対象データのID

string

created_by
optional

作成者のID

string

created_on
optional

作成日

string

is_deletable
optional

削除可否

boolean

is_editable
optional

編集可否

boolean

organ_id
optional

組織ID

string

updated_by
optional

更新者のID

string

updated_on
optional

更新日

string

EntityRelatedItemListModel

関連データリスト

Name Description Schema

collection_display_name
optional

コレクション表示名

string

collection_name
optional

コレクション名

string

item_list
optional

データリスト

< object > array

total_count
optional

総データ件数

integer

EntityRelatedItemListRequest

Polymorphism : Composition

Name Description Schema

data
optional

EntityRelatedItemListRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

EntityRelatedItemListRequestModel

関連データ取得要求

Polymorphism : Composition

Name Description Schema

_id
optional

対象データのID

string

items_per_page
required

ページごとのデータ取得件数

integer

page_index
required

取得ページ番号

integer

sort
optional

SortListModel

target_collection_name_list
optional

取得対象コレクション名のリスト(指定しない場合は全て)

< string > array

EntityRelatedItemListResponse

Polymorphism : Composition

Name Description Schema

data
optional

EntityRelatedItemListResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

EntityRelatedItemListResponseModel

関連データ取得結果

Name Schema

item_list
optional

< EntityRelatedItemListModel > array

EntitySaveBatchRequest

Polymorphism : Composition

Name Description Schema

data
required

EntitySaveBatchRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

EntitySaveBatchRequestModel

Name Schema

list
required

< EntitySaveModel > array

options
optional

EntitySearchOptionsModel

EntitySaveBatchResponse

Polymorphism : Composition

Name Description Schema

data
optional

EntitySaveBatchResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

EntitySaveBatchResponseModel

Name Description Schema

import_id
optional

インポートID

integer

EntitySaveModel

Name Description Schema

fields
required

項目設定で定義されたフィールド名と、対応する値のマップ

object

key
optional

更新対象データのID。 ・新規データの場合は空白とする。 ・IDに該当するデータが存在しない場合、新たにIDを採番して新しい項目を作成する。 ・値に該当する項目が複数見つかった場合は、最初に見つかった一つだけが更新される。

string

EntitySaveRequest

Polymorphism : Composition

Name Description Schema

data
required

EntitySaveRequestModel

session_id
optional

セッションID(HTTPヘッダにAPIキーを付加している場合は不要)

string

EntitySaveRequestModel

Polymorphism : Composition

Name Description Schema

fields
required

項目設定で定義されたフィールド名と、対応する値のマップ

object

is_async
optional

処理を非同期で実行する(空白の場合はfalse)

boolean

key
optional

更新対象データのID。 ・新規データの場合は空白とする。 ・IDに該当するデータが存在しない場合、新たにIDを採番して新しい項目を作成する。 ・値に該当する項目が複数見つかった場合は、最初に見つかった一つだけが更新される。

string

options
optional

EntitySearchOptionsModel

EntitySaveResponse

Polymorphism : Composition

Name Description Schema

data
optional

EntitySaveResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

EntitySaveResponseModel

更新結果

Name Description Schema

_id
optional

発行、もしくは更新されたデータのID

string

action
optional

新規作成=create, 既存データの更新=update, 削除=delete, 無効化=disable

string

transaction_id
optional

非同期処理の状況取得に利用するためのID

string

EntitySearchOptionModel

Name Description Schema

field_name
optional

フィールド名称

string

input_field_name
optional

関連データの検索フィールド名(input_method=by_field_valueのみ)

string

input_method
optional

関連データの検索方法(by_id=IDで検索, by_name=表示名で検索, by_field_value=特定のフィールドの値で検索)

string

EntitySearchOptionsModel

Name Description Schema

field_search_option_list
optional

フィールドごとに検索方法を変更する場合に設定する

< EntitySearchOptionModel > array

key_search_option
optional

KeySearchOptionModel

search_related_by_name
optional

true=選択項目や関連マスタを表示名称で検索する, false=選択項目や関連マスタをIDで検索する 指定しない場合はIDで検索する。

boolean

EntitySnapShotModel

データの過去のスナップショット

Name Schema

entity
required

entity

log
required

EntityChangeLogModel

entity

Name Description Schema

_id
optional

データのID

string

EntitySnapShotRequest

Polymorphism : Composition

Name Description Schema

data
optional

EntitySnapShotRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

EntitySnapShotRequestModel

スナップショット取得要求

Name Description Schema

log_id
required

対象ログのID

string

EntitySnapShotResponse

Polymorphism : Composition

Name Description Schema

data
optional

EntitySnapShotModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

EntityStatusRequest

Polymorphism : Composition

Name Description Schema

data
required

EntityStatusRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

EntityStatusRequestModel

Name Description Schema

transaction_id
required

データ作成,更新などの際に取得したtransaction_id

string

EntityStatusResponse

Polymorphism : Composition

Name Description Schema

data
optional

EntityStatusResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

EntityStatusResponseModel

Name Description Schema

status
optional

処理状況

string

ExistsMyItemInOrganRequest

Polymorphism : Composition

Name Description Schema

data
required

ExistsMyItemInOrganRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

ExistsMyItemInOrganRequestModel

Name Description Schema

field_name
required

チェック対象のフィールド名

string

ExistsMyItemInOrganResponse

Polymorphism : Composition

Name Description Schema

data
optional

ExistsMyItemInOrganResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

ExistsMyItemInOrganResponseModel

Name Description Schema

exists
optional

誰かの項目リストに存在している場合はTrue

boolean

ExistsSessionResponse

Polymorphism : Composition

Name Description Schema

data
optional

data

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

data

Name Description Schema

organ_id
required

組織ID

integer

user_id
required

ユーザーID

string

ExportStatusRequest

Polymorphism : Composition

Name Description Schema

data
required

ExportStatusRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

ExportStatusRequestModel

Name Description Schema

export_id
required

出力対象レポートのID

integer

ExportStatusResponse

Polymorphism : Composition

Name Description Schema

data
optional

ExportStatusResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

ExportStatusResponseModel

エクスポート状況

Name Description Schema

created_by
optional

実行ユーザーID

string

download_file_path
optional

出力ファイルのダウンロードURL(終了するまでは空白)

string

export_end_at
optional

出力終了日時

string

export_id
optional

エクスポートのID

integer

export_result_count
optional

出力結果件数

integer

export_start_at
optional

出力開始日時

string

file_name
optional

出力ファイル名(終了するまでは空白)

string

status
optional

ステータス

integer

status_text
optional

ステータスのテキスト

string

FieldDefinitionAllListResponse

Polymorphism : Composition

Name Description Schema

data
optional

FieldDefinitionAllListResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

FieldDefinitionAllListResponseItemModel

コレクションごとのフィールド定義リスト

Name Description Schema

collection_name
optional

コレクション名

string

items
optional

< FieldDefinitionModel > array

FieldDefinitionAllListResponseModel

データ取得結果

FieldDefinitionCreateRequest

Polymorphism : Composition

Name Description Schema

data
required

FieldDefinitionCreateRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

FieldDefinitionCreateRequestModel

フィールド更新要求

Polymorphism : Composition

Name Description Schema

base_item_id
optional

親データを指定する場合はIDを入力

string

display_name
optional

フィールド表示名称

string

display_order
optional

表示順位

number

field_name
optional

フィールド名称

string

group_id
optional

フィールドの所属するグループのID

string

input_required
optional

入力必須かどうか。ルックアップ、計算項目、積み上げ集計などユーザーが直接入力しない項目では使用しない。値が「true」入力必須。値が「null」必須でない

boolean

is_hidden
optional

フィールドを非表示とする場合はtrue

boolean

is_unique
optional

フィールドを一意な値をする場合はtrue

boolean

is_url_link
optional

入力文字列をURLリンクとして扱う場合はtrue(String型のみで使用)

boolean

show_large
optional

テキスト型の項目用、値が「1」大きく表示する。値が「0」 大きく表示しない

string

FieldDefinitionDeleteRequest

Polymorphism : Composition

Name Description Schema

data
required

FieldDefinitionDeleteRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

FieldDefinitionDeleteRequestModel

フィールド削除要求

Name Description Schema

_id
required

データのID

string

FieldDefinitionDisableRequest

Polymorphism : Composition

Name Description Schema

data
required

FieldDefinitionDisableRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

FieldDefinitionDisableRequestModel

フィールド非表示要求

Name Description Schema

_id
required

データのID

string

FieldDefinitionEnableRequest

Polymorphism : Composition

Name Description Schema

data
required

FieldDefinitionEnableRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

FieldDefinitionEnableRequestModel

フィールド再表示要求

Name Description Schema

_id
required

データのID

string

FieldDefinitionGroupCreateRequest

Polymorphism : Composition

Name Description Schema

data
required

FieldDefinitionGroupCreateRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

FieldDefinitionGroupCreateRequestModel

グループ作成要求

Name Description Schema

group_name
required

グループ名称

string

order
required

表示順位

integer

FieldDefinitionGroupCreateResponse

Polymorphism : Composition

Name Description Schema

data
optional

FieldDefinitionGroupCreateResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

FieldDefinitionGroupCreateResponseModel

グループ作成結果

Name Description Schema

_id
optional

データのID

string

FieldDefinitionGroupDeleteRequest

Polymorphism : Composition

Name Description Schema

data
required

FieldDefinitionGroupDeleteRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

FieldDefinitionGroupDeleteRequestModel

グループ削除要求

Name Description Schema

_id
required

削除対象データのID

string

FieldDefinitionGroupListRequest

Polymorphism : Composition

Name Description Schema

data
required

FieldDefinitionGroupListRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

FieldDefinitionGroupListRequestModel

グループ取得要求

Name Description Schema

with_fields
optional

グループ情報のみを取得する場合はfalse(デフォルトはtrue)

boolean

with_hidden
optional

非表示項目を含む場合はtrue(デフォルトはfalse)

boolean

FieldDefinitionGroupListResponse

Polymorphism : Composition

Name Description Schema

data
optional

FieldDefinitionGroupListResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

FieldDefinitionGroupListResponseModel

データ取得結果

Type : < FieldDefinitionGroupModel > array

FieldDefinitionGroupModel

フィールド定義情報

Name Description Schema

_id
optional

データのID

string

collection_name
optional

コレクション名

string

field_list
optional

< FieldDefinitionModel > array

group_name
optional

グループ名称

string

order
optional

表示順位

integer

FieldDefinitionGroupUpdateRequest

Polymorphism : Composition

Name Description Schema

data
required

FieldDefinitionGroupUpdateRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

FieldDefinitionGroupUpdateRequestModel

グループ更新要求

Name Description Schema

_id
required

更新対象データのID

string

group_name
required

グループ名称

string

FieldDefinitionGroupUpdateResponse

Polymorphism : Composition

Name Description Schema

data
optional

FieldDefinitionGroupUpdateResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

FieldDefinitionGroupUpdateResponseModel

グループ作成結果

Name Description Schema

_id
optional

データのID

string

FieldDefinitionListRequest

Polymorphism : Composition

Name Description Schema

data
required

FieldDefinitionListRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

FieldDefinitionListRequestModel

グループ取得要求

Name Description Schema

with_hidden
optional

非表示項目を含む場合はtrue(デフォルトはfalse)

boolean

with_parent
optional

親コレクションの項目を含む場合はtrue(デフォルトはtrue)

boolean

FieldDefinitionListResponse

Polymorphism : Composition

Name Description Schema

data
optional

FieldDefinitionListResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

FieldDefinitionListResponseModel

データ取得結果

Type : < FieldDefinitionModel > array

FieldDefinitionModel

フィールド定義情報

Name Description Schema

base_item_id
optional__

親の項目定義から引き継いだ項目である場合の項目ID

string

from_base_collection
optional__

親の項目定義から引き継いだ項目である場合は1

integer

_id
optional

データのID

string

aggregate_field
optional

積み上げ集計の集計を行うフィールド名

string

aggregate_field_type
optional

積み上げ集計の集計を行うフィールドの型

string

aggregate_interest
optional

積み上げ集計対象データのcollection_name

string

aggregate_operation
optional

積み上げ集計方法

string

align_div
optional

表示する列(left, right, center)

string

candidate_key
optional

重複を禁止するかどうか(1の場合は禁止)

integer

cannot_convert_to_other_collection
optional

レコード変換時の項目マッピング設定の時に、この項目をマッピング元項目に設定できないかどうか

boolean

collection_name
optional

コレクション名

string

column_name
optional

参照先テーブルとの結合カラム名

string

conditions
optional

積み上げ集計の集計対象の検索条件のオブジェクト

AndConditionListModel

created_on
optional

作成日時

string

default_div
optional

デフォルトの項目かどうか(1の場合はデフォルト)

integer

disable_div
optional

有効・無効

integer

display_name
optional

表示名

string

display_order
optional

表示順位

integer

division_code
optional

区分コード(現在のところ、組み込みの「都道府県」専用)

string

division_list
optional

区分リスト

< division_list > array

eval_data_type
optional

条件設定や出力時に適用されるデータ型

string

external_base_collection_name
optional

参照先コレクションで検索を行う際の基準コレクション名

string

external_collection_name
optional

参照先コレクション名

string

external_collection_singular_name
optional

参照先コレクションの単数形名

string

external_field_name
optional

参照先コレクションの結合カラム名

string

external_name_field_name
optional

参照先コレクションの表示カラム名

string

field_name
optional

フィールド名

string

formula
optional

計算項目の計算式

string

from_parent
optional

親コレクションの項目に対する直接の参照である場合はtrue

boolean

group_id
optional

所属している入力グループのID

string

hidden_div
optional

1の場合は非表示

integer

input_required
optional

入力必須項目かどうか。値が「null」=「必須でない」、値が「true」=「必須である」

boolean

is_builtin
optional

システムで利用する、組み込みの項目である場合にtrue

boolean

is_conditioned
optional

積み上げ集計の集計対象の検索条件の有無 0:全てのレコード, 1:一定の条件のレコード

integer

is_owned_user_field
optional

table型の項目で、そのデータを所有するユーザーを表すフィールドである場合にtrue

boolean

is_url_link
optional

入力文字列をURLリンクとして扱う場合はtrue(String型のみで使用)

boolean

list_div
optional

商談の繰り返し計上の項目である場合に1

integer

lookup_collection
optional

ルックアップ項目の参照先コレクション名

string

lookup_field
optional

ルックアップ項目の参照先フィールド名

string

lookup_field_type
optional

ルックアップ項目の参照先フィールドのデータ型

string

name_column_name
optional

参照先テーブルの表示カラム名

string

number_of_decimals
optional

計算項目を数値型で出力する場合の、小数点以下の桁数

string

output_format
optional

計算項目の出力形式(number, date, time1(m時間n分), time2(l日m時間n分), string)

string

picklist_dependency
optional

選択項目制御用 organ_itemにも入れておく

picklist_dependency

show_large
optional

typeがtextの場合、表示領域を大きくするかどうか。値が「0」=「しない」、値が「1」=「する」

string

table_name
optional

参照先テーブル名

string

table_singular_name
optional

テーブル名の単数形名

string

type
optional

データ型

string

updated_on
optional

更新日時

string

user_editable
optional

falseの場合は編集不可

boolean

division_list

Name Description Schema

display_order
optional

表示順位

integer

field_name
optional

string

key
optional

区分値

integer

sales_board_filter_field_name
optional

string

sales_board_filter_from_date
optional

string

sales_board_filter_range_type
optional

string

sales_board_filter_to_date
optional

string

value
optional

区分表示値

string

picklist_dependency

Name Description Schema

inclusion_settings
optional

< inclusion_settings > array

large_category_field_name
optional

大項目のフィールド名

string

inclusion_settings

Name Schema

large_category_select_div
optional

string

small_category_select_divs
optional

< string > array

FieldDefinitionMoveRequest

Polymorphism : Composition

Name Description Schema

data
required

FieldDefinitionMoveRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

FieldDefinitionMoveRequestModel

フィールド移動要求

Name Schema

list
required

< list > array

list

Name Description Schema

_id
required

移動対象となる項目のID

string

align
optional

移動対象となる項目の表示列(left / right)

string

group_id
optional

移動対象となる項目のグループID

string

order
required

移動対象となる項目のorder

integer

FieldDefinitionUpdateBaseRequestModel

フィールド更新要求

Name Description Schema

display_name
optional

フィールド表示名称

string

display_order
optional

表示順位

number

field_name
optional

フィールド名称

string

group_id
optional

フィールドの所属するグループのID

string

input_required
optional

入力必須かどうか。ルックアップ、計算項目、積み上げ集計などユーザーが直接入力しない項目では使用しない。値が「true」入力必須。値が「null」必須でない

boolean

is_hidden
optional

フィールドを非表示とする場合はtrue

boolean

is_unique
optional

フィールドを一意な値をする場合はtrue

boolean

is_url_link
optional

入力文字列をURLリンクとして扱う場合はtrue(String型のみで使用)

boolean

show_large
optional

テキスト型の項目用、値が「1」大きく表示する。値が「0」 大きく表示しない

string

FieldDefinitionUpdateRequest

Polymorphism : Composition

Name Description Schema

data
required

FieldDefinitionUpdateRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

FieldDefinitionUpdateRequestModel

フィールド更新要求

Polymorphism : Composition

Name Description Schema

_id
optional

データのID

string

display_name
optional

フィールド表示名称

string

display_order
optional

表示順位

number

field_name
optional

フィールド名称

string

group_id
optional

フィールドの所属するグループのID

string

input_required
optional

入力必須かどうか。ルックアップ、計算項目、積み上げ集計などユーザーが直接入力しない項目では使用しない。値が「true」入力必須。値が「null」必須でない

boolean

is_hidden
optional

フィールドを非表示とする場合はtrue

boolean

is_unique
optional

フィールドを一意な値をする場合はtrue

boolean

is_url_link
optional

入力文字列をURLリンクとして扱う場合はtrue(String型のみで使用)

boolean

show_large
optional

テキスト型の項目用、値が「1」大きく表示する。値が「0」 大きく表示しない

string

FieldDefinitionUpdateResponse

Polymorphism : Composition

Name Description Schema

data
optional

FieldDefinitionUpdateResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

FieldDefinitionUpdateResponseModel

フィールド更新結果

Name Description Schema

_id
optional

データのID

string

FormulaFieldDefinitionCheckRequest

Polymorphism : Composition

Name Description Schema

data
required

FormulaFieldDefinitionCheckRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

FormulaFieldDefinitionCheckRequestModel

Polymorphism : Composition

Name Description Schema

formula
optional

計算項目の計算式

string

number_of_decimals
optional

計算項目を数値型で出力する場合の、小数点以下の桁数

string

output_format
optional

計算項目の出力形式(number, date, time1(m時間n分), time2(l日m時間n分), string)

string

target_item_id
optional

チェック対象データのID(空白の場合、一番初めに取得されたデータが使われる)

string

FormulaFieldDefinitionCheckResponse

Polymorphism : Composition

Name Description Schema

data
optional

FormulaFieldDefinitionCheckResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

FormulaFieldDefinitionCheckResponseModel

Name Description Schema

formula_result
required

計算結果

string

is_success
required

チェック結果(成功であればtrue)

boolean

FormulaFieldDefinitionCreateRequest

Polymorphism : Composition

Name Description Schema

data
required

FormulaFieldDefinitionCreateRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

FormulaFieldDefinitionCreateRequestModel

Polymorphism : Composition

Name Description Schema

base_item_id
optional

親データを指定する場合はIDを入力

string

display_name
optional

フィールド表示名称

string

display_order
optional

表示順位

number

field_name
optional

フィールド名称

string

formula
optional

計算項目の計算式

string

group_id
optional

フィールドの所属するグループのID

string

input_required
optional

入力必須かどうか。ルックアップ、計算項目、積み上げ集計などユーザーが直接入力しない項目では使用しない。値が「true」入力必須。値が「null」必須でない

boolean

is_hidden
optional

フィールドを非表示とする場合はtrue

boolean

is_unique
optional

フィールドを一意な値をする場合はtrue

boolean

is_url_link
optional

入力文字列をURLリンクとして扱う場合はtrue(String型のみで使用)

boolean

number_of_decimals
optional

計算項目を数値型で出力する場合の、小数点以下の桁数

string

output_format
optional

計算項目の出力形式(number, date, time1(m時間n分), time2(l日m時間n分), string)

string

show_large
optional

テキスト型の項目用、値が「1」大きく表示する。値が「0」 大きく表示しない

string

FormulaFieldDefinitionUpdateRequest

Polymorphism : Composition

Name Description Schema

data
required

FormulaFieldDefinitionUpdateRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

FormulaFieldDefinitionUpdateRequestDataModel

Name Description Schema

formula
optional

計算項目の計算式

string

number_of_decimals
optional

計算項目を数値型で出力する場合の、小数点以下の桁数

string

output_format
optional

計算項目の出力形式(number, date, time1(m時間n分), time2(l日m時間n分), string)

string

FormulaFieldDefinitionUpdateRequestModel

Polymorphism : Composition

Name Description Schema

_id
optional

データのID

string

display_name
optional

フィールド表示名称

string

display_order
optional

表示順位

number

field_name
optional

フィールド名称

string

formula
optional

計算項目の計算式

string

group_id
optional

フィールドの所属するグループのID

string

input_required
optional

入力必須かどうか。ルックアップ、計算項目、積み上げ集計などユーザーが直接入力しない項目では使用しない。値が「true」入力必須。値が「null」必須でない

boolean

is_hidden
optional

フィールドを非表示とする場合はtrue

boolean

is_unique
optional

フィールドを一意な値をする場合はtrue

boolean

is_url_link
optional

入力文字列をURLリンクとして扱う場合はtrue(String型のみで使用)

boolean

number_of_decimals
optional

計算項目を数値型で出力する場合の、小数点以下の桁数

string

output_format
optional

計算項目の出力形式(number, date, time1(m時間n分), time2(l日m時間n分), string)

string

show_large
optional

テキスト型の項目用、値が「1」大きく表示する。値が「0」 大きく表示しない

string

GetAdvancedRoleAuthorityRequest

Polymorphism : Composition

Name Description Schema

data
required

GetAdvancedRoleAuthorityRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

GetAdvancedRoleAuthorityRequestModel

ロールの権限一覧取得リクエスト

Name Description Schema

role_object_id
required

権限を取得するロールのObjectID

string

GetAdvancedRoleAuthorityResponse

Polymorphism : Composition

Name Description Schema

data
optional

GetAdvancedRoleAuthorityResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

GetAdvancedRoleAuthorityResponseModel

ロールの権限一覧取得結果

Name Description Schema

authorities
required

権限一覧

< object > array

GetAdvancedRoleDocumentAuthorityRequest

Polymorphism : Composition

Name Description Schema

data
required

GetAdvancedRoleDocumentAuthorityRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

GetAdvancedRoleDocumentAuthorityRequestModel

ロールに対するコレクション内のアクセス制御一覧(ロールが保有するドキュメント毎の閲覧・編集・削除可否リスト)を取得するリクエスト

Name Description Schema

collection_name
required

アクセス制御対象のコレクション名

string

role_object_id
required

アクセス制御一覧を取得するロールのObjectID

string

GetAdvancedRoleDocumentAuthorityResponse

Polymorphism : Composition

Name Description Schema

data
optional

GetAdvancedRoleDocumentAuthorityResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

GetAdvancedRoleDocumentAuthorityResponseModel

ドキュメント毎の閲覧・編集・削除可否リスト

Name Description Schema

document_authorities
required

アクセス制御リスト(ロールが保有するドキュメント毎の閲覧・編集・削除可否リスト)

< object > array

GetAdvancedRoleFieldAuthorityRequest

Polymorphism : Composition

Name Description Schema

data
required

GetAdvancedRoleFieldAuthorityRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

GetAdvancedRoleFieldAuthorityRequestModel

ロールに対するコレクションの項目毎の閲覧・編集可否リストを取得するリクエスト

Name Description Schema

collection_name
required

制御対象のコレクション名

string

role_object_id
required

項目毎の権限を取得するロールのObjectID

string

GetAdvancedRoleFieldAuthorityResponse

Polymorphism : Composition

Name Description Schema

data
optional

GetAdvancedRoleFieldAuthorityResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

GetAdvancedRoleFieldAuthorityResponseModel

項目毎の閲覧・編集可否リスト

Name Description Schema

field_authorities
required

閲覧・編集可否リスト

< field_authorities > array

field_authorities

Name Description Schema

display_name
required

項目名(表示用)

string

editability
required

AbilityModel

field_name
required

項目名(キー)

string

visibility
required

AbilityModel

GetAdvancedRoleRecursiveRequest

Polymorphism : Composition

Name Description Schema

data
required

GetAdvancedRoleRecursiveRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

GetAdvancedRoleRecursiveRequestModel

ロールの階層構造を取得するリクエスト

Name Description Schema

base_role_object_id
optional

階層構造を取得するロールのObjectID(指定しないとルートから取得)

string

num_of_hierarchy
required

取得する階層の数

integer

GetAdvancedRoleRecursiveResponse

Polymorphism : Composition

Name Description Schema

data
optional

GetAdvancedRoleRecursiveResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

GetAdvancedRoleRecursiveResponseModel

ロールの階層構造を取得した結果

Name Schema

role_tree
required

AdvancedRoleTreeModel

GetAdvancedRoleSearchRequest

Polymorphism : Composition

Name Description Schema

data
required

GetAdvancedRoleSearchRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

GetAdvancedRoleSearchRequestModel

ロールを名称でlike検索するリクエスト

Name Description Schema

role_name
required

検索したいロール名の一部

string

GetAdvancedRoleSearchResponse

Polymorphism : Composition

Name Description Schema

data
optional

GetAdvancedRoleSearchResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

GetAdvancedRoleSearchResponseModel

ロールを名称でlike検索した結果

Name Description Schema

roles
required

検索結果

< AdvancedRoleModel > array

GetAdvancedRoleUserListRequest

Polymorphism : Composition

Name Description Schema

data
required

GetAdvancedRoleUserListRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

GetAdvancedRoleUserListRequestModel

ロールに紐づくユーザーの一覧取得リクエスト

Name Description Schema

role_object_id
required

ユーザーを取得するロールのObjectID

string

GetAdvancedRoleUserListResponse

Polymorphism : Composition

Name Description Schema

data
optional

GetAdvancedRoleUserListResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

GetAdvancedRoleUserListResponseModel

ロールに紐づくユーザーの一覧取得結果

Name Schema

users
required

< UserModel > array

GetBusinessCardFieldMappingListRequest

Polymorphism : Composition

Name Description Schema

data
required

GetBusinessCardFieldMappingListRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

GetBusinessCardFieldMappingListRequestModel

名刺項目マッピング一覧取得リクエスト

Name Description Schema

dst_collection_name
optional

変換先コレクション名

string

with_default
required

マッピングが存在しない場合、デフォルトのマッピングを取得するかどうか

boolean

GetBusinessCardFieldMappingListResponse

Polymorphism : Composition

Name Description Schema

data
optional

GetBusinessCardFieldMappingListResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

GetBusinessCardFieldMappingListResponseModel

名刺項目マッピング一覧

Name Schema

list
required

< BusinessCardFieldMappingModel > array

GetBusinessCardFieldMappingRequest

Polymorphism : Composition

Name Description Schema

data
required

GetBusinessCardFieldMappingRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

GetBusinessCardFieldMappingRequestModel

名刺項目マッピング取得リクエスト

Name Description Schema

dst_collection_name
required

変換先コレクション名

string

with_default
required

マッピングが存在しない場合、デフォルトのマッピングを取得するかどうか

boolean

GetBusinessCardFieldMappingResponse

Polymorphism : Composition

Name Description Schema

data
optional

GetBusinessCardFieldMappingResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

GetBusinessCardFieldMappingResponseModel

Name Description Schema

dst_collection_name
required

変換先コレクション名

string

mapping
required

名刺と変換先コレクション間の項目マッピング。{名刺の項目:変換先コレクションの項目}

< string, string > map

GetBusinessCardsDestinationRuleRequest

Polymorphism : Composition

Name Description Schema

data
required

GetBusinessCardsDestinationRuleRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

GetBusinessCardsDestinationRuleRequestModel

organ_idなどが入ればokなので特にパラメータはなし

Name Description Schema

_id
optional

ID

string

GetBusinessCardsDestinationRuleResponse

Polymorphism : Composition

Name Description Schema

data
optional

GetBusinessCardsDestinationRuleResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

GetBusinessCardsDestinationRuleResponseModel

Name Description Schema

destination_rules
optional

ID

< destination_rules > array

destination_rules

Name Description Schema

is_default
optional

明示的に何も選ばないときに何にするかの設定

boolean

rule_display_name
optional

ui上のルールの表示名

string

rule_name
optional

システムで使用するルールの識別子

string

GetBusinessCardsOrganItemsRequest

Polymorphism : Composition

Name Description Schema

data
required

GetBusinessCardsOrganItemsRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

GetBusinessCardsOrganItemsRequestModel

名刺項目定義取得リクエスト

Name Description Schema

dummy
optional

意味なし

string

GetBusinessCardsOrganItemsResponse

Polymorphism : Composition

Name Description Schema

data
optional

GetBusinessCardsOrganItemsResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

GetBusinessCardsOrganItemsResponseModel

Name Description Schema

_id
optional

ID

string

field_list
optional

< FieldDefinitionModel > array

GetColumnListRequest

Polymorphism : Composition

Name Description Schema

data
required

GetColumnListRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

GetColumnListRequestModel

アップロードしたファイルのカラム一覧を取得

Name Description Schema

file_data_id
required

ファイルの登録ID

string

GetColumnListResponse

Polymorphism : Composition

Name Description Schema

data
optional

GetColumnListResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

GetColumnListResponseModel

カラムリスト

Name Schema

columns
optional

< columns > array

columns

Name Description Schema

name
optional

カラム名

string

GetDefaultQueryRequest

Polymorphism : Composition

Name Description Schema

data
required

GetDefaultQueryRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

GetDefaultQueryRequestModel

デフォルトの重複検索用クエリを取得する処理のリクエスト

Name Description Schema

collection_name
required

コレクション名

string

object_id
required

オブジェクトID

string

GetDefaultQueryResponse

Polymorphism : Composition

Name Description Schema

data
optional

GetDefaultQueryResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

GetDefaultQueryResponseModel

デフォルトの重複検索用クエリを取得する処理のレスポンス

Name Schema

condition_list
required

AndConditionListModel

GetInputTemplateRequest

Polymorphism : Composition

Name Description Schema

data
required

GetInputTemplateRequestModel

session_id
optional

セッションID(HTTPヘッダにAPIキーを付加している場合は不要)

string

GetInputTemplateRequestModel

Name Schema

initial_input_list
optional

< initial_input_list > array

initial_input_list

Name Description Schema

field_name
required

初期値として入力するフィールド名

string

value
required

初期値として入力する値

string

GetInputTemplateResponse

Polymorphism : Composition

Name Description Schema

data
optional

GetInputTemplateResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

GetInputTemplateResponseModel

Type : object

GetMyItemListRequest

Polymorphism : Composition

Name Description Schema

data
required

GetMyItemListRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

GetMyItemListRequestModel

Type : object

GetMyItemListResponse

Polymorphism : Composition

Name Description Schema

data
optional

GetMyItemListResponseModel

has_error
required

エラーが発生した場合にtrue

boolean

message
optional

エラーメッセージ

string

GetMyItemListResponseModel

Name Schema

list
optional

< list > array

list

Name Description Schema

field_name
required

フィールド名称

string

order
optional

表示順位

integer

HeapAggregateFieldDefinitionCreateRequest

Polymorphism : Composition

Name Description Schema

data
required

HeapAggregateFieldDefinitionCreateRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

HeapAggregateFieldDefinitionCreateRequestModel

Polymorphism : Composition

Name Description Schema

aggregate_field
optional

積み上げ集計の集計を行うフィールド名

string

aggregate_interest
optional

積み上げ集計対象データのcollection_name

string

aggregate_operation
optional

積み上げ集計方法(record_count, sum, avg, max, min)

string

base_item_id
optional

親データを指定する場合はIDを入力

string

conditions
optional

AndConditionListModel

display_name
optional

フィールド表示名称

string

display_order
optional

表示順位

number

field_name
optional

フィールド名称

string

group_id
optional

フィールドの所属するグループのID

string

input_required
optional

入力必須かどうか。ルックアップ、計算項目、積み上げ集計などユーザーが直接入力しない項目では使用しない。値が「true」入力必須。値が「null」必須でない

boolean

is_conditioned
optional

条件設定を利用する場合はtrue

boolean

is_hidden
optional

フィールドを非表示とする場合はtrue

boolean

is_unique
optional

フィールドを一意な値をする場合はtrue

boolean

is_url_link
optional

入力文字列をURLリンクとして扱う場合はtrue(String型のみで使用)

boolean

show_large
optional

テキスト型の項目用、値が「1」大きく表示する。値が「0」 大きく表示しない

string

HeapAggregateFieldDefinitionUpdateRequest

Polymorphism : Composition

Name Description Schema

data
required

HeapAggregateFieldDefinitionUpdateRequestModel

identity_id
optional

Signlessの場合に利用するCognito Identity Id

string

salt
optional

Signlessの場合に利用するリクエスト検証のsalt

string

session_id
required

セッションID

string

HeapAggregateFieldDefinitionUpdateRequestDataModel

Name Description Schema

aggregate_field
option