logo
Documentation Powered by ReDoc

SPIRAL ver.2 API (1.1)

Download OpenAPI specification:Download

SPIRAL ver.2 APIリファレンス

App

アプリ一覧を取得

アプリの一覧を取得

query Parameters
ids
Array of strings <= 200 items

検索するアプリIDのリスト 最大リストサイズ200

query
string

検索するアプリのキーワード (表示名、説明)。
部分一致による検索。

sort
string
Default: "createdAt:desc"
Enum: "id:asc" "id:desc" "name:asc" "name:desc" "displayName:asc" "displayName:desc" "createdAt:asc" "createdAt:desc" "updatedAt:asc" "updatedAt:desc"

ソートする対象 (ID、識別名、表示名、作成日時、更新日時)。
":asc"を指定すると昇順。":desc"を指定すると降順。

offset
integer
Example: offset=20

リストのオフセット

limit
integer [ 1 .. 200 ]
Default: 20
Example: limit=20

リストの上限

header Parameters
X-Spiral-App-Authority
string
Default: use
Enum: "use" "manage"
Example: manage

アプリ権限種別

利用または管理のどちらの立場としてAPIを実行しようとしているのかを指定する ヘッダーの指定を省略した場合、 use （利用）が指定されたものとしてAPIが実行される

Responses

Response Headers
X-Spiral-App-Authority
string
Enum: "use" "manage"
Example: "manage"

アプリ権限種別

Response Schema: application/json
Array of objects

アプリの一覧

prevOffset
integer

前のリストのオフセット。前のリストが存在しない場合はnull

nextOffset
integer

次のリストのオフセット。次のリストが存在しない場合はnull

totalCount
integer

検索結果の全件数

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "prevOffset": 0,
  • "nextOffset": 40,
  • "totalCount": 200
}

アプリを取得

アプリを取得

path Parameters
appId
required
string

アプリID

header Parameters
X-Spiral-App-Authority
string
Default: use
Enum: "use" "manage"
Example: manage

アプリ権限種別

利用または管理のどちらの立場としてAPIを実行しようとしているのかを指定する ヘッダーの指定を省略した場合、 use （利用）が指定されたものとしてAPIが実行される

Responses

Response Headers
X-Spiral-App-Authority
string
Enum: "use" "manage"
Example: "manage"

アプリ権限種別

Response Schema: application/json
id
string

ID

name
string [ 1 .. 64 ] characters

識別名 重複不可 アルファベット大文字・小文字、数字、アンダースコアのみ使用可能 ただし最初の文字はアルファベットでなければならない 未指定の場合、自動発行

displayName
string

表示名

description
string

説明

revision
integer

リビジョン。アプリを変更するとカウントアップする数値

version
integer

バージョン

defaultPhpVersion
string
Enum: "7.4" "8.1" "system_default"

現在指定可能なPHPバージョンは7.4, 8.1, system_defaultの３種類。 ※system_defaultは、サービス推奨バージョン

現在のsystem_defaultは8.1。 system_defaultを選択している場合、将来PHPサービス推奨バージョンが更新されると自動的にサービス推奨バージョンを参照します。

object

作成者

object

更新者 更新がないレコードの場合は作成者と同じ

createdAt
string <date-time>

作成日時

updatedAt
string <date-time>

更新日時 更新がないレコードの場合は作成日時と同じ

Response Headers
X-Spiral-App-Authority
string
Enum: "use" "manage"
Example: "manage"

アプリ権限種別

Response samples

Content type
application/json
{
  • "id": "100",
  • "name": "Name",
  • "displayName": "アプリ",
  • "description": "アプリ説明",
  • "revision": 2,
  • "version": 1,
  • "defaultPhpVersion": "7.4",
  • "createdBy": {
    },
  • "updatedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

DB

DB一覧を取得

DBの一覧を取得する

path Parameters
app
required
string

アプリID

query Parameters
query
string

検索するDBのキーワード (表示名、説明)。

sort
string
Default: "createdAt:desc"
Enum: "id:asc" "id:desc" "name:asc" "name:desc" "displayName:asc" "displayName:desc" "createdAt:asc" "createdAt:desc" "updatedAt:asc" "updatedAt:desc"

ソートする対象 (ID、識別名、表示名、作成日時、更新日時)。
後に":asc"を入れると昇順。":desc"を入れると降順。

offset
integer
Example: offset=20

リストのオフセット

limit
integer [ 1 .. 200 ]
Default: 20
Example: limit=20

リストの上限

header Parameters
X-Spiral-App-Authority
string
Default: use
Enum: "use" "manage"
Example: manage

アプリ権限種別

利用または管理のどちらの立場としてAPIを実行しようとしているのかを指定する ヘッダーの指定を省略した場合、 use （利用）が指定されたものとしてAPIが実行される

X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

X-Spiral-App-Authority: use の場合にのみ指定が必要

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Authority
string
Enum: "use" "manage"
Example: "manage"

アプリ権限種別

X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
Array of objects

DBの一覧

prevOffset
integer

前のリストのオフセット。前のリストが存在しない場合はnull

nextOffset
integer

次のリストのオフセット。次のリストが存在しない場合はnull

totalCount
integer

検索結果の全件数

Response Headers
X-Spiral-App-Authority
string
Enum: "use" "manage"
Example: "manage"

アプリ権限種別

X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "prevOffset": 0,
  • "nextOffset": 40,
  • "totalCount": 200
}

DBを取得

DBを取得

path Parameters
app
required
string

アプリID

db
required
string

DBID

header Parameters
X-Spiral-App-Authority
string
Default: use
Enum: "use" "manage"
Example: manage

アプリ権限種別

利用または管理のどちらの立場としてAPIを実行しようとしているのかを指定する ヘッダーの指定を省略した場合、 use （利用）が指定されたものとしてAPIが実行される

X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

X-Spiral-App-Authority: use の場合にのみ指定が必要

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Authority
string
Enum: "use" "manage"
Example: "manage"

アプリ権限種別

X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
id
string

DBID

name
string [ 1 .. 64 ] characters

識別名 重複不可 アルファベット大文字・小文字、数字、アンダースコアのみ使用可能 ただし最初の文字はアルファベットでなければならない 未指定の場合、自動発行

displayName
string [ 1 .. 64 ] characters

DB表示名

description
string [ 0 .. 512 ] characters

DB説明

revision
string

DBリビジョン

Array of objects

フィールド一覧

object

作成者

object

更新者 更新がないレコードの場合は作成者と同じ

createdAt
string <date-time>

作成日時

updatedAt
string <date-time>

更新日時 更新がないレコードの場合は作成日時と同じ

Response Headers
X-Spiral-App-Authority
string
Enum: "use" "manage"
Example: "manage"

アプリ権限種別

X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "id": "100",
  • "name": "inquirydb",
  • "displayName": "問い合わせ管理DB",
  • "description": "問い合わせを管理するDBです",
  • "revision": "1",
  • "fields": [
    ],
  • "createdBy": {
    },
  • "updatedBy": {
    },
  • "createdAt": "2021-01-28T03:57:23Z",
  • "updatedAt": "2021-01-28T03:57:23Z"
}

Record

レコード一覧を取得

指定した条件に一致するレコードの一覧を取得

path Parameters
app
required
string

アプリID

db
required
string

DBID

query Parameters
fields
Array of strings <= 150 items
Default: "全フィールド"
Example: fields=name,age

出力するフィールド識別名を配列で指定 最大リストサイズ150 メタ情報フィールドは指定不可。レスポンスに必ず含まれる

where
string
Example: where=@age >= 30 AND @name = 'yamada'

+は%2b、%は%%でエンコードされる where=1%2b1=2 here=1%%1=1 抽出条件式

referrer
string
Example: referrer=123.4:56

参照元から参照されているレコードを絞り込む [参照元DB ID].[参照フィールドID]:[参照元レコードID] または @[アプリ識別名].[参照元DB識別名].[参照フィールド識別名]:[参照元レコードID] のフォーマットで指定 存在しないDB、フィールド、レコードは指定不可 referrerを指定すると、アプリロールで閲覧権限のないレコードを含んだ結果が返される。ただしその場合、フィールド値は返されず、キーは _id, _unauthorized のみとなる includeUnauthorizedとの同時指定不可

includeUnauthorized
boolean
Default: false
Example: includeUnauthorized=true

アプリロールで閲覧権限のないレコードを結果に含める ただしその場合、フィールド値は返されず、キーは _id, _unauthorized のみとなる referrerとの同時指定不可

optionsFormat
string
Default: "id"
Enum: "id" "label"
Example: optionsFormat=label

セレクト、マルチセレクト型のレスポンス形式

enableTotalCount
boolean
Default: false

trueの場合検索結果の対象件数を取得する trueにした場合、登録されているレコード数が多いと、レスポンスまでの時間が長くなる

sort
string
Default: "_id:desc"
Example: sort=_id:asc

ソートする対象:_id、フィールド識別名、_createdAt、_updatedAt ":asc"は昇順、":desc"は降順でソート マルチセレクト、ファイル、パスワード、参照フィールド型および_createdBy、_updatedByは指定不可 referrer または includeUnauthorized を指定した場合は、_id以外でのソート不可

offset
integer [ 0 .. 10000 ]
Default: 0
Example: offset=20

リストのオフセット

limit
integer [ 1 .. 200 ]
Default: 20
Example: limit=20

リストの上限

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
Array of objects

レコードのリスト

object

セレクト、マルチセレクトの選択項目 セレクト、マルチセレクト以外のフィールドタイプには付与されない

prevOffset
integer

前のリストのオフセット。前のリストが存在しない場合はnull

nextOffset
integer

次のリストのオフセット。次のリストが存在しない場合はnull

totalCount
integer

検索結果の全件数

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{}

レコードを登録

レコードを登録

path Parameters
app
required
string

アプリID

db
required
string

DBID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Request Body schema: application/json
string or array

キーにフィールドの識別名を指定 バリューにはキーで指定したフィールドへ格納する値を指定 マルチセレクト、ファイル、複数レコード参照の参照フィールドでは値文字列のリスト それ以外のフィールドタイプでは値文字列 ファイル型フィールドは有効期限を過ぎたファイルキーを指定するとエラー ユーザフィールドは無効ユーザのユーザIDやAPIエージェントのIDを指定するとエラー 指定する値文字列はフィールドタイプによって異なります。詳細はサポートサイトをご確認ください。

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
object

レコード

object

セレクト、マルチセレクトの選択項目 セレクト、マルチセレクト以外のフィールドタイプには付与されない

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Request samples

Content type
application/json
{
  • "(textField)": "text",
  • "(textareaField)": "textarea\ntextarea",
  • "(emailField)": "spiral@example.com",
  • "(phoneField)": "+81 80-1111-2222",
  • "(integerField)": "100",
  • "(doubleField)": "200.1",
  • "(dateField)": "2020-04-30",
  • "(monthDayField)": "04-30",
  • "(timeField)": "17:06:29",
  • "(dateTimeField)": "2020-04-30T17:06:29Z",
  • "(selectField)": "0",
  • "(multiselectField)": [
    ],
  • "(fileField)": [
    ],
  • "(passwordField)": "pK-4Pqec",
  • "(single referenceField)": "14",
  • "(multi referenceField)": [
    ],
  • "(userField)": "1"
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "options": {
    }
}

レコードを取得

指定DBの指定レコードIDのレコードを取得

path Parameters
app
required
string

アプリID

db
required
string

DBID

recordId
required
string

レコードID

query Parameters
optionsFormat
string
Default: "id"
Enum: "id" "label"
Example: optionsFormat=label

セレクト、マルチセレクト型のレスポンス形式

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
object

レコード

object

セレクト、マルチセレクトの選択項目 セレクト、マルチセレクト以外のフィールドタイプには付与されない

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "item": {
    },
  • "options": {
    }
}

レコードを変更

指定DBの指定レコードIDのレコードを変更する

path Parameters
app
required
string

アプリID

db
required
string

DBID

recordId
required
string

レコードID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Request Body schema: application/json
_revision
string

リビジョン番号 更新時、指定されたrevisionが最新のものでない場合、エラーとなる 指定しない場合はチェックを行わない

(fieldName)
string

キーにフィールドの識別名を指定 バリューにはキーで指定したフィールドへ格納する値を指定 ファイル型フィールドは有効期限を過ぎたファイルキーを指定するとエラー ユーザフィールドは無効ユーザのユーザIDやAPIエージェントのIDを指定するとエラー

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
object

レコード

object

セレクト、マルチセレクトの選択項目 セレクト、マルチセレクト以外のフィールドタイプには付与されない

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Request samples

Content type
application/json
{
  • "_revision": "10",
  • "(textField)": "text",
  • "(textareaField)": "textarea\ntextarea",
  • "(emailField)": "spiral@example.com",
  • "(phoneField)": "+81 80-1111-2222",
  • "(integerField)": "100",
  • "(doubleField)": "200.1",
  • "(dateField)": "2020-04-30",
  • "(monthDayField)": "04-30",
  • "(timeField)": "17:06:29",
  • "(dateTimeField)": "2020-04-30T17:06:29Z",
  • "(selectField)": "0",
  • "(multiselectField)": [
    ],
  • "(fileField)": [
    ],
  • "(passwordField)": "pK-4Pqec",
  • "(single referenceField)": "14",
  • "(multi referenceField)": [
    ],
  • "(userField)": "1"
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "options": {
    }
}

レコードを削除

指定DBの指定レコードIDのレコードを削除する

path Parameters
app
required
string

アプリID

db
required
string

DBID

recordId
required
string

レコードID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

参照先フィールドを含めたレコード一覧を取得

指定した条件に一致するレコードの一覧を取得 フィールド指定する事で参照先DBのフィールドや参照先DBの参照先のフィールドを取得する事ができる 詳細はサポートサイトをご確認ください

path Parameters
app
required
string

アプリID

db
required
string

DBID

query Parameters
fields
Array of strings <= 150 items
Default: "自DBの全フィールド"
Example: fields=name,age

出力するフィールド識別名を配列で指定 最大リストサイズ150 参照先DBのフィールドを指定する場合は [参照フィールド識別名].[参照先DBのフィールド識別名] のフォーマットで指定 参照先DBの参照先のフィールドを指定する場合は [参照フィールド識別名].[参照先DBの参照フィールド識別名].[参照先DBの参照先のフィールド識別名] のフォーマットで指定

自DBのメタ情報フィールドは指定不可。レスポンスに必ず含まれる 参照先DBの参照先のフィールドは、[参照フィールド識別名]、[参照先DBの参照フィールド識別名]のいずれかが複数参照の場合は指定不可 単一参照の場合は、_id以外のメタ情報フィールドとファイル、パスワード、複数参照の参照フィールドのフィールドは指定不可。参照先DBの参照先の場合は、単一参照の参照フィールドも指定不可 複数参照の場合は、6フィールド以上は指定不可。_id以外のメタ情報フィールドとテキストエリア、マルチセレクト、ファイル、パスワード、参照フィールド、ユーザフィールドのフィールドは指定不可 参照フィールドは合わせて6フィールド以上は指定不可

where
string
Example: where=@age >= 30 AND @name = 'yamada'

+は%2b、%は%%でエンコードされる where=1%2b1=2 here=1%%1=1 抽出条件式 参照先DBのフィールド、参照先DBの参照先のフィールドは指定不可

optionsFormat
string
Default: "id"
Enum: "id" "label"
Example: optionsFormat=label

セレクト、マルチセレクト型のレスポンス形式

enableTotalCount
boolean
Default: false

trueの場合検索結果の対象件数を取得する trueにした場合、登録されているレコード数が多いと、レスポンスまでの時間が長くなる

sort
string
Default: "_id:desc"
Example: sort=_id:asc

ソートする対象:_id、フィールド識別名、_createdAt、_updatedAt ":asc"は昇順、":desc"は降順でソート マルチセレクト、ファイル、パスワード、参照フィールド、_createdBy、_updatedBy、参照先DBのフィールド、参照先DBの参照先のフィールドは指定不可

offset
integer [ 0 .. 10000 ]
Default: 0
Example: offset=20

リストのオフセット

limit
integer [ 1 .. 200 ]
Default: 20
Example: limit=20

リストの上限

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
Array of objects

レコードのリスト

object

セレクト、マルチセレクトの選択項目
セレクト、マルチセレクト以外のフィールドタイプには付与されない

prevOffset
integer

前のリストのオフセット。前のリストが存在しない場合はnull

nextOffset
integer

次のリストのオフセット。次のリストが存在しない場合はnull

totalCount
integer

検索結果の全件数

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "options": {
    },
  • "prevOffset": 0,
  • "nextOffset": 40,
  • "totalCount": 200
}

参照先フィールドを含めたレコードを取得

指定DBの指定レコードIDのレコードを取得 フィールド指定する事で参照先DBのフィールドや参照先DBの参照先のフィールドを取得する事ができる 詳細はサポートサイトをご確認ください

path Parameters
app
required
string

アプリID

db
required
string

DBID

recordId
required
string

レコードID

query Parameters
fields
Array of strings <= 150 items
Default: "自DBの全フィールド"
Example: fields=name,age

出力するフィールド識別名を配列で指定 最大リストサイズ150 参照先DBのフィールドを指定する場合は [参照フィールド識別名].[参照先DBのフィールド識別名] のフォーマットで指定 参照先DBの参照先のフィールドを指定する場合は [参照フィールド識別名].[参照先DBの参照フィールド識別名].[参照先DBの参照先のフィールド識別名] のフォーマットで指定

自DBのメタ情報フィールドは指定不可。レスポンスに必ず含まれる 参照先DBの参照先のフィールドは、[参照フィールド識別名]、[参照先DBの参照フィールド識別名]のいずれかが複数参照の場合は指定不可 単一参照の場合は、_id以外のメタ情報フィールドとファイル、パスワード、複数参照の参照フィールドのフィールドは指定不可。参照先DBの参照先の場合は、単一参照の参照フィールドも指定不可 複数参照の場合は、6フィールド以上は指定不可。_id以外のメタ情報フィールドとテキストエリア、マルチセレクト、ファイル、パスワード、参照フィールド、ユーザフィールドのフィールドは指定不可 参照フィールドは合わせて6フィールド以上は指定不可

optionsFormat
string
Default: "id"
Enum: "id" "label"
Example: optionsFormat=label

セレクト、マルチセレクト型のレスポンス形式

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
object

レコード

object

セレクト、マルチセレクトの選択項目
セレクト、マルチセレクト以外のフィールドタイプには付与されない

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "item": {
    },
  • "options": {
    }
}

レコードを検証

レコード識別子とパスワードの一致を検証する レコードを識別する為の入力必須かつ重複不可のフィールドとパスワード型フィールドのあるデータベースに対して使用する

path Parameters
app
required
string

アプリID

db
required
string

DBID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Request Body schema: application/json
required
object

レコードの識別に使用する入力必須かつ重複不可のフィールド フィールドの値が一致するレコードを検索して検証する

required
object

検証対象のパスワード型フィールド 検証する値と登録値の一致を確認する 登録値がnullの場合は、検証する値にnullを指定しても検証結果は失敗になる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
verified
boolean

検証結果 trueの場合、レコードが存在し、パスワードが一致する。 falseの場合、なにかしらの理由でレコード識別子とパスワードの一致が確認できない。

true
true
false
recordId
string

レコードID

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Request samples

Content type
application/json
{
  • "idField": {
    },
  • "passwordField": {
    }
}

Response samples

Content type
application/json
Example
true
true
false
{
  • "verified": "true",
  • "recordId": "10"
}

Record (bulk)

複数レコードを登録

指定DBに最大1000件のレコードを一括登録する パスワード型フィールド、ファイル型フィールド、ユーザフィールドは対象外の為、指定するとエラー

path Parameters
app
required
string

アプリID

db
required
string

DBID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Request Body schema: application/json
required
Array of objects <= 1000 items

レコードの配列

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
ids
Array of strings

レコードIDの配列

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Request samples

Content type
application/json
{
  • "records": [
    ]
}

Response samples

Content type
application/json
{
  • "ids": [
    ]
}

複数レコードを更新

レコードを一括更新する 最大1,000件まで指定可能 更新キーは、入力必須かつ重複不可フィールドまたはレコードIDで指定する。フィールド指定の場合はテキスト型またはメールアドレス型が指定可能。これら以外を指定するとエラー。 パスワード型フィールド、ファイル型フィールド、ユーザフィールドは更新不可。更新対象に指定した場合はエラー。 更新対象のレコードが存在しない場合は無視する 更新する値がない場合でも更新日時やリビジョン番号は更新される

path Parameters
app
required
string

アプリID

db
required
string

DBID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Request Body schema: application/json
required
Array of objects <= 1000 items

レコードの配列

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
ids
Array of strings

レコードIDの配列

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Request samples

Content type
application/json
{
  • "records": [
    ]
}

Response samples

Content type
application/json
{
  • "ids": [
    ]
}

複数レコードを削除

指定した削除キーのレコードを最大1000件一括削除する

path Parameters
app
required
string

アプリID

db
required
string

DBID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Request Body schema: application/json
ids
Array of strings <= 1000 items

レコードIDの配列

idsを指定した場合は、削除キーがレコードIDとなる idsまたはkeyのどちらかを必ず指定

key
string

削除キーに指定する入力必須かつ重複不可のフィールド

テキスト、メールアドレス型のフィールドを識別名で指定する idsまたはkeyのどちらかを必ず指定

values
Array of strings <= 1000 items

削除キーを指定した場合の値を配列で指定

keyを指定した場合は必須

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "key": "CustomerId",
  • "values": [
    ]
}

Record (export)

レコード一括出力依頼一覧を取得

指定DBの一括出力依頼の一覧を取得 一括出力依頼が完了しているとstatusがsucceededに更新され、ファイルURLを取得できる 生成されたファイルは24時間後に自動削除される statusがcanceled、succeeded、failedの依頼は14日後に自動削除される

path Parameters
app
required
string

アプリID

db
required
string

DBID

query Parameters
sort
string
Default: "createdAt:desc"
Enum: "id:asc" "id:desc" "status:asc" "status:desc" "createdAt:asc" "createdAt:desc" "finishedAt:asc" "finishedAt:desc"

ソートする対象 (一括出力依頼ID、ステータス、作成日時、処理終了日時) フィールド識別名の後に":asc"を入れると昇順、":desc"を入れると降順

offset
integer
Example: offset=20

リストのオフセット

limit
integer [ 1 .. 200 ]
Default: 20
Example: limit=20

リストの上限

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
Array of objects

レコードの一括出力依頼のリスト

prevOffset
integer

前のリストのオフセット。前のリストが存在しない場合はnull

nextOffset
integer

次のリストのオフセット。次のリストが存在しない場合はnull

totalCount
integer

検索結果の全件数

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "prevOffset": 0,
  • "nextOffset": 40,
  • "totalCount": 200
}

レコード一括出力依頼を作成

指定DBのレコードを一括出力依頼を作成 出力されたファイルは、レコードの一括出力依頼を確認APIでファイルURLを取得してダウンロードする ファイルは100MiB単位で分割される 生成されたファイルは1アカウントあたり最大30ファイルまで一時的に保存される 30ファイル分が一時保存されている状態で新規依頼をリクエストすると、作成日時が一番古いファイルから削除される また一時保存されているファイルは生成されてから24時間後に自動削除される statusがwaitingの依頼は最大5件まで依頼可能

path Parameters
app
required
string

アプリID

db
required
string

DBID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Request Body schema: application/json
fileName
string [ 1 .. 128 ] characters
Default: "{DB識別名}_{依頼日時の年月日時分}"

ファイル名 アルファベット大文字・小文字、数字のみ使用可能

fileFormat
string
Default: "tsv"
Enum: "tsv" "csv"

ファイルフォーマット

characterCode
string
Default: "utf-8"
Enum: "utf-8" "utf-8WithBOM"

文字コード

hasHeader
boolean
Default: true

trueの場合、ヘッダありのファイルを出力 falseの場合、ヘッダなしのファイルを出力

headerType
string
Default: "name"
Enum: "name" "displayName" "fieldId"

ヘッダに出力するタイプ hasHeader が未指定もしくはtrueの場合、指定可能 falseの場合、指定されるとエラー

sort
string
Default: "_id:ASC"

ファイル内のレコードの並び順 ソートできるフィールド対象 (レコードID、ユーザ作成フィールド) マルチセレクト、ファイル、パスワード、参照フィールド型および_createdBy、_updatedByは指定不可 フィールド識別名の後に":ASC"又は":asc"を入れると昇順、":DESC"又は":desc"を入れると降順

where
string [ 1 .. 4096 ] characters

高度な条件抽出 抽出条件式を記述する 詳細はサポートサイトをご確認ください。

object

他DBのフィールド値による抽出 未指定の場合、抽出しない

object

配信エラー除外 未指定の場合、抽出しない

Array of objects

出力するフィールドのリスト 指定したフィールドの並び順でファイルを出力 未指定の場合、全フィールドを出力

recordValueTimeZone
string
Default: "UTC"

日時フィールド、作成日時、更新日時を指定したタイムゾーンの時刻に変換して出力する タイムゾーンの一覧はサポートサイトをご確認ください。

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
id
string

一括出力依頼ID

operatedFrom
string
Enum: "ui" "api"

操作元

fileName
string

ファイル名

fileFormat
string
Enum: "tsv" "csv"

ファイルフォーマット

characterCode
string
Enum: "utf-8" "utf-8WithBOM"

文字コード

hasHeader
boolean

trueの場合、ヘッダありのファイルを出力 falseの場合、ヘッダなしのファイルを出力

headerType
string
Enum: "name" "displayName" "fieldId"

ヘッダに出力するタイプ

sort
string

ファイル内のレコードの並び順 ソートできるフィールド対象 (レコードID、ユーザ作成フィールド) マルチセレクト、ファイル、パスワード、参照フィールド型および_createdBy、_updatedByは指定不可 フィールド識別名の後に":ASC"又は":asc"を入れると昇順、":DESC"又は":desc"を入れると降順

where
string

高度な条件抽出 抽出条件式を記述する 詳細はサポートサイトをご確認ください。

object

他DBのフィールド値による抽出 未指定の場合、抽出しない

object

配信エラー除外 未指定の場合、抽出しない

Array of objects

出力するフィールドのリスト 指定したフィールドの並び順でファイルを出力 未指定の場合、全フィールドを出力

recordValueTimeZone
string

日時フィールド、作成日時、更新日時を指定したタイムゾーンの時刻に変換して出力する タイムゾーンの一覧はサポートサイトをご確認ください。

status
string
Enum: "waiting" "processing" "canceling" "canceled" "succeeded" "failed"

依頼状況ステータス

createdAt
string <date-time>

作成日時

updatedAt
string <date-time>

更新日時

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Request samples

Content type
application/json
{
  • "fileName": "recordExport",
  • "fileFormat": "tsv",
  • "characterCode": "utf-8",
  • "hasHeader": true,
  • "headerType": "name",
  • "sort": "_id:DESC",
  • "where": "@email ILIKE '%@example.com' OR @email ILIKE '%@example.net' AND @birthDay >= DATE('1990-01-01') AND @birthDay <= DATE('2000-12-31')",
  • "exists": {
    },
  • "excludeEmailError": {
    },
  • "fields": [
    ],
  • "recordValueTimeZone": "Asia/Tokyo"
}

Response samples

Content type
application/json
{
  • "id": "100",
  • "operatedFrom": "ui",
  • "fileName": "string",
  • "fileFormat": "tsv",
  • "characterCode": "utf-8",
  • "hasHeader": true,
  • "headerType": "name",
  • "sort": "_id:DESC",
  • "where": "string",
  • "exists": {
    },
  • "excludeEmailError": {
    },
  • "fields": [
    ],
  • "recordValueTimeZone": "Asia/Tokyo",
  • "status": "waiting",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

レコード一括出力依頼を取得

指定DBの一括出力依頼を取得 一括出力依頼が完了しているとstatusがsucceededに更新され、ファイルURLを取得できる 生成されたファイルは24時間後に自動削除される statusがcanceled、succeeded、failedの依頼は14日後に自動削除される

path Parameters
app
required
string

アプリID

db
required
string

DBID

recordExportId
required
string

一括出力依頼ID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
id
string

一括出力依頼ID

operatedFrom
string
Enum: "ui" "api"

操作元

fileName
string

ファイル名

fileFormat
string
Enum: "tsv" "csv"

ファイルフォーマット

characterCode
string
Enum: "utf-8" "utf-8WithBOM"

文字コード

hasHeader
boolean

trueの場合、ヘッダありのファイルを出力 falseの場合、ヘッダなしのファイルを出力

headerType
string
Enum: "name" "displayName" "fieldId"

ヘッダに出力するタイプ

sort
string

ファイル内のレコードの並び順 ソートできるフィールド対象 (レコードID、ユーザ作成フィールド) マルチセレクト、ファイル、パスワード、参照フィールド型および_createdBy、_updatedByは指定不可 フィールド識別名の後に":ASC"又は":asc"を入れると昇順、":DESC"又は":desc"を入れると降順

where
string

高度な条件抽出 抽出条件式を記述する 詳細はサポートサイトをご確認ください。

object

他DBのフィールド値による抽出 未指定の場合、抽出しない

object

配信エラー除外 未指定の場合、抽出しない

Array of objects

出力するフィールドのリスト 指定したフィールドの並び順でファイルを出力 未指定の場合、全フィールドを出力

status
string
Enum: "waiting" "processing" "canceling" "canceled" "succeeded" "failed"

依頼状況ステータス

Array of objects

一括出力で生成されたファイル
statusがsucceededの時に出力

errorMessage
object

エラーメッセージ statusがfailedの時に出力

createdAt
string <date-time>

作成日時

finishedAt
string <date-time>

処理終了日時 statusがcanceled、succeeded、failedの時に出力

fileDeletedAt
string <date-time>

ファイル削除日時 statusがsucceededかつファイルが削除された時に出力

recordValueTimeZone
string

日時フィールド、作成日時、更新日時を指定したタイムゾーンの時刻に変換して出力する タイムゾーンの一覧はサポートサイトをご確認ください。

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "id": "100",
  • "operatedFrom": "ui",
  • "fileName": "string",
  • "fileFormat": "tsv",
  • "characterCode": "utf-8",
  • "hasHeader": true,
  • "headerType": "name",
  • "sort": "_id:DESC",
  • "where": "string",
  • "exists": {
    },
  • "excludeEmailError": {
    },
  • "fields": [
    ],
  • "status": "waiting",
  • "files": [],
  • "errorMessage": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "fileDeletedAt": "2019-08-24T14:15:22Z",
  • "recordValueTimeZone": "Asia/Tokyo"
}

レコード一括出力依頼をキャンセル

一括出力が完了していない依頼をキャンセル キャンセル可能な依頼のstatusはwaitingもしくはprocessing statusがwaitingの場合、statusがcanceledに更新される processingの場合、cancelingに更新される cancelingはサービス内部のキャンセル処理完了後にcanceledに更新される その他statusに対して実行するとエラー

path Parameters
app
required
string

アプリID

db
required
string

DBID

recordExportId
required
string

一括出力依頼ID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
id
string

一括出力依頼ID

operatedFrom
string
Enum: "ui" "api"

操作元

fileName
string

ファイル名

fileFormat
string
Enum: "tsv" "csv"

ファイルフォーマット

characterCode
string
Enum: "utf-8" "utf-8WithBOM"

文字コード

hasHeader
boolean

trueの場合、ヘッダありのファイルを出力 falseの場合、ヘッダなしのファイルを出力

headerType
string
Enum: "name" "displayName" "fieldId"

ヘッダに出力するタイプ

sort
string

ファイル内のレコードの並び順 ソートできるフィールド対象 (レコードID、ユーザ作成フィールド) マルチセレクト、ファイル、パスワード、参照フィールド型および_createdBy、_updatedByは指定不可 フィールド識別名の後に":ASC"又は":asc"を入れると昇順、":DESC"又は":desc"を入れると降順

where
string

高度な条件抽出 抽出条件式を記述する 詳細はサポートサイトをご確認ください。

object

他DBのフィールド値による抽出 未指定の場合、抽出しない

object

配信エラー除外 未指定の場合、抽出しない

Array of objects

出力するフィールドのリスト 指定したフィールドの並び順でファイルを出力 未指定の場合、全フィールドを出力

status
string
Enum: "waiting" "processing" "canceling" "canceled" "succeeded" "failed"

依頼状況ステータス

createdAt
string <date-time>

作成日時

finishedAt
string <date-time>

処理終了日時 statusがcanceled、succeeded、failedの時に出力

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "id": "100",
  • "operatedFrom": "ui",
  • "fileName": "string",
  • "fileFormat": "tsv",
  • "characterCode": "utf-8",
  • "hasHeader": true,
  • "headerType": "name",
  • "sort": "_id:DESC",
  • "where": "string",
  • "exists": {
    },
  • "excludeEmailError": {
    },
  • "fields": [
    ],
  • "status": "waiting",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z"
}

Record (batch)

レコード一括登録依頼一覧を取得

指定DBの一括登録依頼の一覧を取得

path Parameters
app
required
string

アプリID

db
required
string

DBID

query Parameters
sort
string
Default: "createdAt:desc"
Enum: "id:asc" "id:desc" "status:asc" "status:desc" "createdAt:asc" "createdAt:desc" "finishedAt:asc" "finishedAt:desc"

ソートする対象 (ID、ステータス、作成日時、終了日時) ":asc"を指定すると昇順。":desc"を指定すると降順 ステータスを指定した場合は処理が遷移する順番になります

offset
integer
Example: offset=20

リストのオフセット

limit
integer [ 1 .. 200 ]
Default: 20
Example: limit=20

リストの上限

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
Array of objects
prevOffset
integer

前のリストのオフセット。前のリストが存在しない場合はnull

nextOffset
integer

次のリストのオフセット。次のリストが存在しない場合はnull

totalCount
integer

検索結果の全件数

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "prevOffset": 0,
  • "nextOffset": 40,
  • "totalCount": 200
}

レコード一括登録依頼を作成

レコードの一括登録依頼を作成 Multipart/form-data形式 同一DB上で、レコードの一括登録/一括更新/一括削除が処理中の場合は新たに依頼をすることはできません パスワード型フィールド・ファイル型フィールド・ユーザフィールドは対象外の為、インポートファイルのヘッダ行にパスワード型フィールド・ファイル型フィールド・ユーザフィールドの識別名が指定されているとエラー

path Parameters
app
required
string

アプリID

db
required
string

DBID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Request Body schema: multipart/form-data
onError
string
Default: "rollback"
Enum: "rollback" "ignore"

一括登録中にレコードに関する以下のエラーが発生した場合の処理の扱い

  • フィールドタイプに合わない値がある
  • 入力必須のフィールドに値がない
  • 重複不可のフィールドに重複する値がある "rollback"を指定すると全てのレコードの登録処理をしない "ignore"を指定すると対象のレコードをスキップし、正常なレコードのみ登録する
file
required
string <binary>

インポートファイル。以下の条件を満たす必要あり

  • 拡張子がtsvあるいはcsv
  • 文字コードがUTF-8
  • ファイルサイズが100MB以下
  • ファイルにヘッダ行を付ける(1行目にフィールドの識別名)
  • ファイル型フィールドは対象外の為、ヘッダ行にファイル型フィールドの識別名が指定されていない
  • ファイル名に\、 /、 :、 *、 ?、 "、 <、 >、 |が含まれていない

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
id
string

一括登録依頼ID

operatedFrom
string
Enum: "ui" "api"

操作元

status
string
Value: "waiting"

ステータス

Array of objects

エラー情報

onError
string
Enum: "rollback" "ignore"

一括登録中にレコードに関するエラーが発生した場合の処理の扱い

fileName
string

インポートファイル名

fileSize
integer

インポートファイルサイズ(byte)

numberRows
integer

インポートファイルの全行数

numberRowsSuccessful
integer

登録に成功した行数

numberRowsFailed
integer

登録に失敗した行数

rowsFailed
string

登録に失敗したレコード行の番号(カンマ区切り)

createdAt
string <date-time>

作成日時

finishedAt
string <date-time>

一括登録完了日時 ステータスが"canceled"になった時に出力される

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Request samples 

name,email,phone,gender,age,birthday,mailGroup,registration,lastAccess
山田 太郎,taro.yamada@example.com,+81 90-1234-5678,1,30,01-01,"1,2",2020-01-01,2020-01-01T00:00:00Z
田中 次郎,jiro.tanaka@example.com,090-1234-5678,1,25,1-1,3,2020-1-1,2020-01-01T12:00:00+09:00
鈴木 花子,hanako.suzuki@example.com,9012345678,2,20,12-20,,2020-12-20,2020-12-30T12:00:00Z

Response samples

Content type
application/json
{
  • "id": "100",
  • "operatedFrom": "ui",
  • "status": "waiting",
  • "errors": [
    ],
  • "onError": "rollback",
  • "fileName": "content.csv",
  • "fileSize": 104857600,
  • "numberRows": 100,
  • "numberRowsSuccessful": 100,
  • "numberRowsFailed": 100,
  • "rowsFailed": "1,3,4",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z"
}

レコード一括登録依頼を取得

指定DBの一括登録依頼を取得

path Parameters
app
required
string

アプリID

db
required
string

DBID

batchInsertId
required
string

一括登録依頼ID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
id
string

一括登録依頼ID

operatedFrom
string
Enum: "ui" "api"

操作元

status
string
Enum: "waiting" "processing" "canceling" "succeeded" "failed" "canceled"

ステータス

Array of objects

エラー情報 ステータスが"failed"になった時に出力される

onError
string
Enum: "rollback" "ignore"

一括登録中にレコードに関するエラーが発生した場合の処理の扱い

fileName
string

インポートファイル名

fileSize
integer

インポートファイルサイズ(byte)

numberRows
integer

インポートファイルの全行数 ステータスが"processing"になった時に出力される

numberRowsSuccessful
integer

登録に成功した行数 ステータスが"processing"後に"succeeded"または"failed"または"canceled"になった時に出力される

numberRowsFailed
integer

登録に失敗した行数 ステータスが"processing"後に"succeeded"または"failed"または"canceled"になった時に出力される

rowsFailed
string

登録に失敗したレコード行の番号(カンマ区切り)

createdAt
string <date-time>

作成日時

finishedAt
string <date-time>

一括登録完了日時 ステータスが"succeeded"または"failed"または"canceled"になった時に出力される

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "id": "100",
  • "operatedFrom": "ui",
  • "status": "waiting",
  • "errors": [
    ],
  • "onError": "rollback",
  • "fileName": "content.csv",
  • "fileSize": 104857600,
  • "numberRows": 100,
  • "numberRowsSuccessful": 100,
  • "numberRowsFailed": 100,
  • "rowsFailed": "1,3,4",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z"
}

レコード一括登録依頼をキャンセル

レコードの一括登録依頼をキャンセルする statusが"waiting"または"processing"の時に有効

path Parameters
app
required
string

アプリID

db
required
string

DBID

batchInsertId
required
string

一括登録依頼ID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
id
string

一括登録依頼ID

operatedFrom
string
Enum: "ui" "api"

操作元

status
string
Enum: "canceling" "canceled"

ステータス

Array of objects

エラー情報

onError
string
Enum: "rollback" "ignore"

一括登録中にレコードに関するエラーが発生した場合の処理の扱い

fileName
string

インポートファイル名

fileSize
integer

インポートファイルサイズ(byte)

numberRows
integer

インポートファイルの全行数

numberRowsSuccessful
integer

登録に成功した行数

numberRowsFailed
integer

登録に失敗した行数

rowsFailed
string

登録に失敗したレコード行の番号(カンマ区切り)

createdAt
string <date-time>

作成日時

finishedAt
string <date-time>

一括登録完了日時 ステータスが"canceled"になった時に出力される

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "id": "100",
  • "operatedFrom": "ui",
  • "status": "canceling",
  • "errors": [
    ],
  • "onError": "rollback",
  • "fileName": "content.csv",
  • "fileSize": 104857600,
  • "numberRows": 100,
  • "numberRowsSuccessful": 100,
  • "numberRowsFailed": 100,
  • "rowsFailed": "1,3,4",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z"
}

レコード一括更新依頼一覧を取得

指定DBの一括更新依頼の一覧を取得

path Parameters
app
required
string

アプリID

db
required
string

DBID

query Parameters
upsert
boolean

trueの場合、一括登録更新依頼を取得する falseの場合、一括更新依頼を取得する 未指定の場合、両方取得する

sort
string
Default: "createdAt:desc"
Enum: "id:asc" "id:desc" "status:asc" "status:desc" "createdAt:asc" "createdAt:desc" "finishedAt:asc" "finishedAt:desc"

ソートする対象 (ID、ステータス、作成日時、終了日時) ":asc"を指定すると昇順。":desc"を指定すると降順 ステータスを指定した場合は処理が遷移する順番になります

offset
integer
Example: offset=20

リストのオフセット

limit
integer [ 1 .. 200 ]
Default: 20
Example: limit=20

リストの上限

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
Array of objects
prevOffset
integer

前のリストのオフセット。前のリストが存在しない場合はnull

nextOffset
integer

次のリストのオフセット。次のリストが存在しない場合はnull

totalCount
integer

検索結果の全件数

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "prevOffset": 0,
  • "nextOffset": 40,
  • "totalCount": 200
}

レコード一括更新依頼を作成

レコードの一括更新依頼を作成 Multipart/form-data形式 upsertを指定することで更新後の登録処理が可能 同一DB上で、レコードの一括登録/一括更新/一括削除が処理中の場合は新たに依頼をすることはできません パスワード型フィールド・ファイル型フィールド・ユーザフィールドは対象外の為、インポートファイルのヘッダ行にパスワード型フィールド・ファイル型フィールド・ユーザフィールドの識別名が指定されているとエラー

一括更新中に以下のエラーが発生した場合は全てのレコードの更新処理をせずにロールバックする

  • フィールドタイプに合わない値がある
  • 入力必須のフィールドに値がない
  • 重複不可のフィールドに重複する値がある
path Parameters
app
required
string

アプリID

db
required
string

DBID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Request Body schema: multipart/form-data
upsert
boolean
Default: false

一括登録更新を行うためのフラグ trueの場合、DBのレコードに存在するデータを更新し、存在しないデータを新規登録する falseの場合、更新のみで新規登録はしない。

updateKeyField
string
Default: "_id"

更新キー 入力必須かつ重複不可フィールドまたはレコードIDで指定 フィールド指定の場合はテキスト型またはメールアドレス型が指定可能 これら以外を指定するとエラー

file
required
string <binary>

インポートファイル ファイル条件は以下

  • 拡張子がtsvあるいはcsv
  • ファイル名に\、 /、 :、 *、 ?、 "、 <、 >、 |が含まれていない
  • 文字コードがUTF-8
  • ファイルサイズが100MB以下
  • ファイルにヘッダ行がある
  • ヘッダ行にフィールドの識別名が指定されている
  • DBに更新キーフィ－ルドが存在しない
  • ファイルに更新キーフィ－ルド名が含まれない
  • ファイル型フィールドは対象外の為、ヘッダ行にファイル型フィールドの識別名が指定されていない

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
id
string

一括更新依頼ID

operatedFrom
string
Enum: "ui" "api"

操作元

upsert
boolean

登録処理の有無

updateKeyField
string

更新対象キーフィルド

status
string
Value: "waiting"

ステータス

Array of objects

エラー情報

fileName
string

インポートファイル名

fileSize
integer

インポートファイルサイズ(byte)

numberRows
integer

インポートファイルの全行数

numberRowsInsertSuccessful
integer

登録に成功した行数

numberRowsInsertFailed
integer

登録に失敗した行数

numberRowsUpdateSuccessful
integer

更新に成功した行数

numberRowsUpdateFailed
integer

更新に失敗した行数

rowsFailed
string

登録・更新に失敗した行

createdAt
string <date-time>

作成日時

finishedAt
string <date-time>

一括更新完了日時 ステータスが"canceled"になった時に出力される

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Request samples 

_id name,email,phone,gender,age,birthday,mailGroup,registration,lastAccess
1 山田 太郎,taro.yamada@example.com,+81 90-1234-5678,1,30,01-01,"1,2",2020-01-01,2020-01-01T00:00:00Z
2 田中 次郎,jiro.tanaka@example.com,090-1234-5678,1,25,1-1,3,2020-1-1,2020-01-01T12:00:00+09:00
3 鈴木 花子,hanako.suzuki@example.com,9012345678,2,20,12-20,,2020-12-20,2020-12-30T12:00:00Z

Response samples

Content type
application/json
{
  • "id": "100",
  • "operatedFrom": "ui",
  • "upsert": false,
  • "updateKeyField": "_id",
  • "status": "waiting",
  • "errors": [
    ],
  • "fileName": "content.csv",
  • "fileSize": 104857600,
  • "numberRows": 100,
  • "numberRowsInsertSuccessful": 100,
  • "numberRowsInsertFailed": 100,
  • "numberRowsUpdateSuccessful": 100,
  • "numberRowsUpdateFailed": 100,
  • "rowsFailed": "1,3,4",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z"
}

レコード一括更新依頼を取得

指定DBの一括更新依頼を取得

path Parameters
app
required
string

アプリID

db
required
string

DBID

batchUpdateId
required
string

一括更新依頼ID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
id
string

一括更新依頼ID

operatedFrom
string
Enum: "ui" "api"

操作元

upsert
boolean

登録処理の有無

updateKeyField
string

更新対象キーフィールド

status
string
Enum: "waiting" "processing" "canceling" "succeeded" "failed" "canceled"

ステータス

Array of objects

エラー情報 ステータスが"failed"になった時に出力される

fileName
string

インポートファイル名

fileSize
integer

インポートファイルサイズ(byte)

numberRows
integer

インポートファイルの全行数 ステータスが"processing"になった時に出力される

numberRowsInsertSuccessful
integer

登録に成功した行数

numberRowsInsertFailed
integer

登録に失敗した行数

numberRowsUpdateSuccessful
integer

更新に成功した行数

numberRowsUpdateFailed
integer

更新に失敗した行数

rowsFailed
string

登録・更新に失敗した行

createdAt
string <date-time>

作成日時

finishedAt
string <date-time>

一括更新完了日時 ステータスが"succeeded"または"failed"または"canceled"になった時に出力される

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "id": "100",
  • "operatedFrom": "ui",
  • "upsert": false,
  • "updateKeyField": "_id",
  • "status": "waiting",
  • "errors": [
    ],
  • "fileName": "content.csv",
  • "fileSize": 104857600,
  • "numberRows": 100,
  • "numberRowsInsertSuccessful": 100,
  • "numberRowsInsertFailed": 100,
  • "numberRowsUpdateSuccessful": 100,
  • "numberRowsUpdateFailed": 100,
  • "rowsFailed": "1,3,4",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z"
}

レコード一括更新依頼をキャンセル

レコードの一括更新依頼をキャンセルする statusが"waiting"または"processing"の時に有効

path Parameters
app
required
string

アプリID

db
required
string

DBID

batchUpdateId
required
string

一括更新依頼ID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
id
string

一括更新依頼ID

operatedFrom
string
Enum: "ui" "api"

操作元

upsert
boolean

登録処理の有無

updateKeyField
string

更新対象キーフィルド

status
string
Enum: "canceling" "canceled"

ステータス

Array of objects

エラー情報

fileName
string

インポートファイル名

fileSize
integer

インポートファイルサイズ(byte)

numberRows
integer

インポートファイルの全行数

numberRowsInsertSuccessful
integer

登録に成功した行数

numberRowsInsertFailed
integer

登録に失敗した行数

numberRowsUpdateSuccessful
integer

更新に成功した行数

numberRowsUpdateFailed
integer

更新に失敗した行数

rowsFailed
string

登録・更新に失敗した行

createdAt
string <date-time>

作成日時

finishedAt
string <date-time>

一括更新完了日時 ステータスが"canceled"になった時に出力される

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "id": "100",
  • "operatedFrom": "ui",
  • "upsert": false,
  • "updateKeyField": "string",
  • "status": "canceling",
  • "errors": [
    ],
  • "fileName": "content.csv",
  • "fileSize": 104857600,
  • "numberRows": 100,
  • "numberRowsInsertSuccessful": 100,
  • "numberRowsInsertFailed": 100,
  • "numberRowsUpdateSuccessful": 100,
  • "numberRowsUpdateFailed": 100,
  • "rowsFailed": "1,3,4",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z"
}

レコード一括削除依頼一覧を取得

指定DBの一括削除依頼の一覧を取得

path Parameters
app
required
string

アプリID

db
required
string

DBID

query Parameters
sort
string
Default: "createdAt:desc"
Enum: "id:asc" "id:desc" "status:asc" "status:desc" "createdAt:asc" "createdAt:desc" "finishedAt:asc" "finishedAt:desc"

ソートする対象 (ID、ステータス、作成日時、終了日時) ":asc"を指定すると昇順。":desc"を指定すると降順 ステータスを指定した場合は処理が遷移する順番になります

offset
integer
Example: offset=20

リストのオフセット

limit
integer [ 1 .. 200 ]
Default: 20
Example: limit=20

リストの上限

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
Array of objects
prevOffset
integer

前のリストのオフセット。前のリストが存在しない場合はnull

nextOffset
integer

次のリストのオフセット。次のリストが存在しない場合はnull

totalCount
integer

検索結果の全件数

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "prevOffset": 0,
  • "nextOffset": 40,
  • "totalCount": 200
}

レコード一括削除依頼を作成

レコードの一括削除依頼を作成 同一DB上で、レコードの一括登録/一括更新/一括削除が処理中の場合は新たに依頼をすることはできません

path Parameters
app
required
string

アプリID

db
required
string

DBID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Request Body schema: application/json
where
string

抽出条件式 条件未設定の場合は、条件なしとして扱う

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
id
string

一括削除依頼ID

operatedFrom
string
Enum: "ui" "api"

操作元

status
string
Value: "waiting"

ステータス

Array of objects

エラー情報

where
string

抽出条件式

numberRowsDeleted
integer

削除した行数

createdAt
string <date-time>

作成日時

finishedAt
string <date-time>

一括削除完了日時

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Request samples

Content type
application/json
{
  • "where": "@age >= 30 AND @name = 'yamada'"
}

Response samples

Content type
application/json
{
  • "id": "100",
  • "operatedFrom": "ui",
  • "status": "waiting",
  • "errors": [
    ],
  • "where": "@age >= 30 AND @name = 'yamada'",
  • "numberRowsDeleted": 100,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z"
}

レコード一括削除依頼を取得

指定DBの一括削除依頼を取得

path Parameters
app
required
string

アプリID

db
required
string

DBID

batchDeleteId
required
string

一括削除依頼ID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
id
string

一括削除依頼ID

operatedFrom
string
Enum: "ui" "api"

操作元

status
string
Enum: "waiting" "processing" "canceling" "succeeded" "failed" "canceled"

ステータス

Array of objects

エラー情報 ステータスが"failed"になった時に出力される

where
string

抽出条件式

numberRowsDeleted
integer

削除した行数 ステータスが"succeeded"または"failed"または"canceled"になった時に出力される

createdAt
string <date-time>

作成日時

finishedAt
string <date-time>

一括削除完了日時 ステータスが"succeeded"または"failed"または"canceled"になった時に出力される

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "id": "100",
  • "operatedFrom": "ui",
  • "status": "waiting",
  • "errors": [
    ],
  • "where": "@age >= 30 AND @name = 'yamada'",
  • "numberRowsDeleted": 100,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z"
}

レコード一括削除依頼をキャンセル

レコードの一括削除依頼をキャンセルする statusが"waiting"または"processing"の時に有効

path Parameters
app
required
string

アプリID

db
required
string

DBID

batchDeleteId
required
string

一括削除依頼ID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
id
string

一括削除依頼ID

operatedFrom
string
Enum: "ui" "api"

操作元

status
string
Enum: "canceling" "canceled"

ステータス

Array of objects

エラー情報

where
string

抽出条件式

numberRowsDeleted
integer

削除した行数 ステータスが"canceled"になった時に出力される

createdAt
string <date-time>

作成日時

finishedAt
string <date-time>

一括削除完了日時 ステータスが"canceled"になった時に出力される

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "id": "100",
  • "operatedFrom": "ui",
  • "status": "canceling",
  • "errors": [
    ],
  • "where": "@age >= 30 AND @name = 'yamada'",
  • "numberRowsDeleted": 100,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z"
}

Record File

ファイルアップロードトークンを発行

レコードのファイル型フィールドにファイルを登録する際に、事前にファイルをアップロードするに必要なトークンを発行する
アカウント単位で最大3個までトークンを発行できる
有効なトークンが3個ある状態でリクエストするとエラーになる
トークンは発行してから3分超過もしくはトークンを使用してファイルアップロードされると削除される

path Parameters
app
required
string

アプリID

db
required
string

DBID

field
required
string

フィールドID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
fileUploadToken
string

ファイルアップロードトークン

expireAt
string <date-time>

ファイルアップロードトークンの期限切れ日時
期限切れ日時になるとトークンは自動で削除される

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "fileUploadToken": "a0eebc999c0b4ef8bb6d6bb9bd380a11",
  • "expireAt": "2019-07-17T01:51:04Z"
}

ファイルをアップロード

レコードのファイル型フィールドにファイルを登録する際に、事前に取得したトークンを用いてファイルをアップロードする
Multipart/form-data形式
アップロード後に取得できるファイルキーを用いて、レコードとファイルキーを関連づけることで、
アップロードしたファイルはアカウントのファイルストレージ容量の対象となる
レコードと関連付けされていないファイルは、アップロードしてから1時間後に削除される

path Parameters
app
required
string

アプリID

db
required
string

DBID

field
required
string

フィールドID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Request Body schema: multipart/form-data
file
required
string <binary>

ファイル ファイル名に\、 /、 :、 *、 ?、 "、 <、 >、 |が含まれているとエラー ファイル型フィールドの入力制限を満たしていないとエラー

fileUploadToken
required
string

ファイルアップロードトークン 有効期限の切れたトークンならエラー

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
fileKey
string

ファイルキー フォーマットは"シーケンシャルID_ファイルハッシュ値"

fileName
string

ファイル名

fileSize
integer

ファイルサイズ(byte)

object

登録者

createdAt
string <date-time>

登録日時

expireAt
string <date-time>

ファイルの期限切れ日時
期限切れ日時になるとファイルは自動で削除される
レコードと関連付けられるとnullになる

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Request samples

Content type
multipart/form-data
----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="sample.png"
Content-Type: image/png

[file content goes there]
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="fileUploadToken"

a0eebc999c0b4ef8bb6d6bb9bd380a11
------WebKitFormBoundary7MA4YWxkTrZu0gW--

Response samples

Content type
application/json
{
  • "fileKey": "100_196a921286f74e15cd307dc42f1df4523b3e25808659789631092b458d57676e",
  • "fileName": "sample.png",
  • "fileSize": 2345,
  • "createdBy": {
    },
  • "createdAt": "2019-07-17T00:51:04Z",
  • "expireAt": "2019-07-17T01:51:04Z"
}

ファイルをダウンロード

レコードのファイル型フィールドに登録したファイルをダウンロードする
fileKey はレコード取得APIのファイル型フィールドのレスポンスにて取得できる
アカウント単位で最大3並列までファイルをダウンロードできる
ファイル型フィールドと関連づいていないファイルのダウンロードはエラーになる

path Parameters
app
required
string

アプリID

db
required
string

DBID

field
required
string

フィールドID

fileKey
required
string

ファイルキー

recordId
required
string

レコードID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Express Email

EXPRESSメール設定一覧を取得

EXPRESSメール設定の一覧を取得する

path Parameters
app
required
string

アプリID

db
required
string

DBID

query Parameters
expressStatus
string
Enum: "setting" "ready" "closed"

検索するEXPRESSメールのステータス

emailJobStatus
string
Enum: "spooling" "failed" "waiting" "delivering" "finished" "forceCanceled" "canceled"

検索するEXPRESSメールのメール配信ジョブのステータス 本番メール配信ジョブのみが対象

statusCategory
string
Enum: "settingStatus" "deliveredStatus"

"settingStatus"の場合は設定中、予約完了、配信準備中、配信待機中のステータスのEXPRESSメールの一覧を取得する "deliveredStatus"の場合は配信中、配信終了、配信失敗、強制配信中止のステータスのEXPRESSメールの一覧を取得する expressStatus、emailJobStatusとの併用はできない

subject
string

検索するEXPRESSメールの件名のキーワード 部分一致による検索 最大128byte

sort
string
Default: "updatedAt:desc"
Enum: "startedAt:asc" "startedAt:desc" "status:asc" "status:desc" "updatedAt:asc" "updatedAt:desc"

ソートする対象 (配信開始日時、ステータス、更新日時)。 後に":asc"を入れると昇順。":desc"を入れると降順。

offset
integer
Example: offset=20

リストのオフセット

limit
integer [ 1 .. 200 ]
Default: 20
Example: limit=20

リストの上限

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
Array of objects

EXPRESSメール設定の一覧

prevOffset
integer

前のリストのオフセット。前のリストが存在しない場合はnull

nextOffset
integer

次のリストのオフセット。次のリストが存在しない場合はnull

totalCount
integer

検索結果の全件数

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "prevOffset": 0,
  • "nextOffset": 40,
  • "totalCount": 200
}

EXPRESSメール設定を作成

EXPRESSメール設定を作成する

path Parameters
app
required
string

アプリID

db
required
string

DBID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Request Body schema: application/json
required
object

宛先設定

excludeErrorCount
integer [ 1 .. 3 ]
Default: 1

配信エラー除外の対象とするエラーの発生回数

object

他DBのメールアドレスの有無による抽出 nullの場合抽出しない

required
object

差出人設定

replyTo
string [ 5 .. 256 ] characters

返信先設定 任意のメールアドレスを指定する

required
object

件名

object

プレーンテキストメールの本文 plainBody、htmlBodyの少なくともどちらかは必須

object

HTMLメールの本文 plainBody、htmlBodyの少なくともどちらかは必須

contentsTimeZone
string
Default: "UTC"

タイムゾーンを扱う日時フィールド、作成日時、最終更新日時の差替えキーワードを件名か本文に含める場合に、差替え時のタイムゾーンを指定する タイムゾーンの一覧はサポートサイトをご確認ください。

timing
required
string
Enum: "scheduled" "now"

配信タイミング選択 scheduled（予約配信） か now（即時配信） を選択する

scheduleDate
string <date-time>

予約日時 以下の範囲内の日時を指定可能 ・ 現在時刻から10分経過後かつ2年以内 ・ 毎時00分から5分刻み

timingがscheduledのときは必須 timingがnowのときに指定するとエラー

status
string
Default: "setting"
Enum: "setting" "ready"

ステータス選択 setting（設定中）かready（設定完了）を選択する

timingがnowのとき、readyを選択すると配信が開始される timingがscheduledのとき、readyを選択すると待機状態となる

readyを指定した場合、以下のバリデーションが行われる

  • fromに設定したドメイン設定の送信ドメイン認証
    • ドメイン設定が存在しない、または利用不可の場合はエラー
  • （timingがscheduledの場合のみ）予約日時
    • scheduleDate に指定可能な範囲外の日時が指定されていた場合はエラー

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
id
string

EXPRESSメールID

object

宛先設定

excludeErrorCount
integer

除外対象とするエラーの発生回数

object

他DBのメールアドレスの有無による抽出 nullの場合抽出しない

object

差出人設定

replyTo
string

返信先設定 任意のメールアドレスを指定する

object

件名

object

プレーンテキストメールの本文

object

HTMLメールの本文

contentsTimeZone
string
Default: "UTC"

タイムゾーンを扱う日時フィールド、作成日時、最終更新日時の差替えキーワードを件名か本文に含める場合に、差替え時のタイムゾーンを指定する タイムゾーンの一覧はサポートサイトをご確認ください。

timing
string
Enum: "scheduled" "now"

配信タイミング選択 scheduled（予約配信） か now（即時配信） を選択する

scheduleDate
string <date-time>

予約日時 以下の範囲内の日時を指定可能 ・ 現在時刻から10分経過後かつ2年以内 ・ 毎時00分から5分刻み

timingがscheduledのときは必須 timingがnowのときに指定するとエラー

status
string
Enum: "setting" "ready" "closed"

EXPRESSメール配信設定のステータス

object

メール配信実行情報 本番配信が開始されるまではnull

object

作成者

object

更新者 更新がないレコードの場合は作成者と同じ

createdAt
string <date-time>

作成日時

updatedAt
string <date-time>

更新日時 更新がないレコードの場合は作成日時と同じ

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Request samples

Content type
application/json
{
  • "to": {
    },
  • "excludeErrorCount": 1,
  • "exists": {
    },
  • "from": {
    },
  • "replyTo": "reply@example.com",
  • "subject": {
    },
  • "plainBody": {
    },
  • "htmlBody": {
    },
  • "contentsTimeZone": "Asia/Tokyo",
  • "timing": "scheduled",
  • "scheduleDate": "2017-01-01T12:00:00Z",
  • "status": "setting"
}

Response samples

Content type
application/json
{
  • "excludeErrorCount": 1,
  • "exists": {
    },
  • "from": {
    },
  • "replyTo": "reply@example.com",
  • "subject": {
    },
  • "plainBody": {
    },
  • "htmlBody": {
    },
  • "contentsTimeZone": "Asia/Tokyo",
  • "timing": "scheduled",
  • "scheduleDate": "2017-01-01T12:00:00Z",
  • "status": "setting",
  • "emailJob": {
    },
  • "createdBy": {
    },
  • "updatedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

EXPRESSメール設定を取得

指定されたEXPRESSメール設定を取得する

path Parameters
app
required
string

アプリID

db
required
string

DBID

expressEmailId
required
string

EXPRESSメールID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
id
string

EXPRESSメールID

object

宛先設定

excludeErrorCount
integer

除外対象とするエラーの発生回数

object

他DBのメールアドレスの有無による抽出 nullの場合抽出しない

object

差出人設定

replyTo
string

返信先設定 任意のメールアドレスを指定する

object

件名

object

プレーンテキストメールの本文

object

HTMLメールの本文

contentsTimeZone
string
Default: "UTC"

タイムゾーンを扱う日時フィールド、作成日時、最終更新日時の差替えキーワードを件名か本文に含める場合に、差替え時のタイムゾーンを指定する タイムゾーンの一覧はサポートサイトをご確認ください。

timing
string
Enum: "scheduled" "now"

配信タイミング選択 scheduled（予約配信） か now（即時配信） を選択する

scheduleDate
string <date-time>

予約日時 以下の範囲内の日時を指定可能 ・ 現在時刻から10分経過後かつ2年以内 ・ 毎時00分から5分刻み

timingがscheduledのときは必須 timingがnowのときに指定するとエラー

status
string
Enum: "setting" "ready" "closed"

EXPRESSメール配信設定のステータス

object

メール配信実行情報 本番配信が開始されるまではnull

object

作成者

object

更新者 更新がないレコードの場合は作成者と同じ

createdAt
string <date-time>

作成日時

updatedAt
string <date-time>

更新日時 更新がないレコードの場合は作成日時と同じ

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "excludeErrorCount": 1,
  • "exists": {
    },
  • "from": {
    },
  • "replyTo": "reply@example.com",
  • "subject": {
    },
  • "plainBody": {
    },
  • "htmlBody": {
    },
  • "contentsTimeZone": "Asia/Tokyo",
  • "timing": "scheduled",
  • "scheduleDate": "2017-01-01T12:00:00Z",
  • "status": "setting",
  • "emailJob": {
    },
  • "createdBy": {
    },
  • "updatedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

EXPRESSメール設定を更新

指定されたEXPRESSメール設定を更新する ステータスが"setting"/"ready"のもの以外を指定するとエラー ステータスが"ready"のときはstatusのみ変更できる（それ以外のパラメータは変更できない）

path Parameters
app
required
string

アプリID

db
required
string

DBID

expressEmailId
required
string

EXPRESSメールID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Request Body schema: application/json
object

宛先設定

excludeErrorCount
integer [ 1 .. 3 ]

配信エラー除外の対象とするエラーの発生回数

object

他DBのメールアドレスの有無による抽出 nullの場合抽出しない

object

差出人設定

replyTo
string [ 5 .. 256 ] characters

返信先設定 任意のメールアドレスを指定する

object

件名

object

プレーンテキストメールの本文 nullの場合は本文を削除する

object

HTMLメールの本文 nullの場合は本文を削除する

contentsTimeZone
string
Default: "UTC"

タイムゾーンを扱う日時フィールド、作成日時、最終更新日時の差替えキーワードを件名か本文に含める場合に、差替え時のタイムゾーンを指定する タイムゾーンの一覧はサポートサイトをご確認ください。

timing
string
Enum: "scheduled" "now"

配信タイミング選択 scheduled（予約配信） か now（即時配信） を選択する

scheduleDate
string <date-time>

予約日時 以下の範囲内の日時を指定可能 ・ 現在時刻から10分経過後かつ2年以内 ・ 毎時00分から5分刻み

timingがscheduledのときは必須 timingがnowのときに指定するとエラー

status
string
Enum: "setting" "ready"

ステータス選択 setting（設定中）かready（設定完了）を選択する

timingがnowのとき、readyを選択すると配信が開始される timingがscheduledのとき、readyを選択すると待機状態となる

readyを指定した場合、以下のバリデーションが行われる

  • fromに設定したドメイン設定の送信ドメイン認証
    • ドメイン設定が存在しない、または利用不可の場合はエラー
  • （timingがscheduledの場合のみ）予約日時
    • scheduleDate に指定可能な範囲外の日時が指定されていた場合はエラー

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
id
string

EXPRESSメールID

object

宛先設定

excludeErrorCount
integer

除外対象とするエラーの発生回数

object

他DBのメールアドレスの有無による抽出 nullの場合抽出しない

object

差出人設定

replyTo
string

返信先設定 任意のメールアドレスを指定する

object

件名

object

プレーンテキストメールの本文

object

HTMLメールの本文

contentsTimeZone
string
Default: "UTC"

タイムゾーンを扱う日時フィールド、作成日時、最終更新日時の差替えキーワードを件名か本文に含める場合に、差替え時のタイムゾーンを指定する タイムゾーンの一覧はサポートサイトをご確認ください。

timing
string
Enum: "scheduled" "now"

配信タイミング選択 scheduled（予約配信） か now（即時配信） を選択する

scheduleDate
string <date-time>

予約日時 以下の範囲内の日時を指定可能 ・ 現在時刻から10分経過後かつ2年以内 ・ 毎時00分から5分刻み

timingがscheduledのときは必須 timingがnowのときに指定するとエラー

status
string
Enum: "setting" "ready" "closed"

EXPRESSメール配信設定のステータス

object

メール配信実行情報 本番配信が開始されるまではnull

object

作成者

object

更新者 更新がないレコードの場合は作成者と同じ

createdAt
string <date-time>

作成日時

updatedAt
string <date-time>

更新日時 更新がないレコードの場合は作成日時と同じ

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Request samples

Content type
application/json
{
  • "to": {
    },
  • "excludeErrorCount": 1,
  • "exists": {
    },
  • "from": {
    },
  • "replyTo": "reply@example.com",
  • "subject": {
    },
  • "plainBody": {
    },
  • "htmlBody": {
    },
  • "contentsTimeZone": "Asia/Tokyo",
  • "timing": "scheduled",
  • "scheduleDate": "2017-01-01T12:00:00Z",
  • "status": "setting"
}

Response samples

Content type
application/json
{
  • "excludeErrorCount": 1,
  • "exists": {
    },
  • "from": {
    },
  • "replyTo": "reply@example.com",
  • "subject": {
    },
  • "plainBody": {
    },
  • "htmlBody": {
    },
  • "contentsTimeZone": "Asia/Tokyo",
  • "timing": "scheduled",
  • "scheduleDate": "2017-01-01T12:00:00Z",
  • "status": "setting",
  • "emailJob": {
    },
  • "createdBy": {
    },
  • "updatedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

EXPRESSメール設定を削除

指定されたEXPRESSメール設定を削除する ステータスが"setting"のもの以外を指定するとエラー

path Parameters
app
required
string

アプリID

db
required
string

DBID

expressEmailId
required
string

EXPRESSメールID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

テスト配信を実行

DBのレコードに対してテスト配信を実行する

path Parameters
app
required
string

アプリID

db
required
string

DBID

expressEmailId
required
string

EXPRESSメールID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Request Body schema: application/json
required
object

宛先設定

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
emailJobId
string

メール配信ジョブID

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Request samples

Content type
application/json
{
  • "to": {
    }
}

Response samples

Content type
application/json
{
  • "emailJobId": "100"
}

Email Job

EXPRESSメール配信ジョブ一覧を取得

EXPRESSメール配信ジョブの一覧を取得する

path Parameters
app
required
string

アプリID

db
required
string

DBID

query Parameters
ids
Array of strings

検索するメール配信ジョブIDのリスト 最大リストサイズ200

isTest
boolean

trueを指定するとテスト配信のジョブに絞り込まれる falseを指定すると本番配信のジョブに絞り込まれる

offset
integer
Example: offset=20

リストのオフセット

limit
integer [ 1 .. 200 ]
Default: 20
Example: limit=20

リストの上限

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
Array of objects

EXPRESSメール配信ジョブの一覧

prevOffset
integer

前のリストのオフセット。前のリストが存在しない場合はnull

nextOffset
integer

次のリストのオフセット。次のリストが存在しない場合はnull

totalCount
integer

検索結果の全件数

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "prevOffset": 0,
  • "nextOffset": 40,
  • "totalCount": 200
}

EXPRESSメール配信ジョブを取得

指定のemailJobIdのEXPRESSメール配信ジョブを取得する

path Parameters
app
required
string

アプリID

db
required
string

DBID

emailJobId
required
string

メール配信ジョブID

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
id
string

メール配信ジョブID

expressEmailId
string

EXPRESSメールID

deliveredCount
string

配信通数 配信が開始されるまではnull

errorCount
string

配信エラー件数 配信が開始された後、初めて配信エラーを受け取るまではnull

startedAt
string <date-time>

配信開始時刻 配信が開始されるまではnull 配信件数が0件の場合は配信準備開始時刻

requiredTime
string <second>

所要時間 配信が開始されるまではnull

isTest
boolean

テスト配信の場合true

status
string
Enum: "spooling" "failed" "waiting" "delivering" "finished" "forceCanceled"

配信ステータス

errorCode
string

ステータスがfailedの時のみエラーコードが表示される

errorDetail
string

エラーコードの詳細

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "id": "100",
  • "expressEmailId": "string",
  • "deliveredCount": "10",
  • "errorCount": "2",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "requiredTime": "3600",
  • "isTest": true,
  • "status": "finished",
  • "errorCode": "U101",
  • "errorDetail": "EmailTypeNotSupport"
}

App Log

EXPRESSメール配信ログ一覧を取得

指定した条件でEXPRESSメール配信ログ一覧を取得 各検索条件は全てANDで結合される

path Parameters
app
required
string

アプリID

db
required
string

DBID

query Parameters
email
string

検索する宛先メールアドレス 部分一致による検索

messageId
string

検索するメッセージID

sinceDeliveryDate
string <date-time>
Example: sinceDeliveryDate=1970-01-01T00:00:00Z

検索する配信日時 指定した日時以降のメール配信ログで絞り込む

untilDeliveryDate
string <date-time>
Example: untilDeliveryDate=1970-01-01T00:00:00Z

検索する配信日時 指定した日時以前のメール配信ログで絞り込む

emailJobId
string

検索するメール配信ジョブID

recordId
string

検索する配信元レコードID

errorCode
string <5.x.x or 4.x.x or NULL or NOT NULL>

検索する配信エラーコード 前方一致で検索を行う

enableTotalCount
boolean
Default: false

trueの場合検索結果の対象件数を取得する

sort
string
Default: "messageId:desc"
Enum: "messageId:asc" "messageId:desc" "deliveryDate:asc" "deliveryDate:desc"

ソートする対象 (メッセージID、配信日時) 後に":asc"を入れると昇順。":desc"を入れると降順

offset
integer
Example: offset=20

リストのオフセット

limit
integer [ 1 .. 200 ]
Default: 20
Example: limit=20

リストの上限

header Parameters
X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
Array of objects

EXPRESSメール配信ログの一覧

prevOffset
integer

前のリストのオフセット。前のリストが存在しない場合はnull

nextOffset
integer

次のリストのオフセット。次のリストが存在しない場合はnull

totalCount
integer

検索結果の全件数

Response Headers
X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "prevOffset": 0,
  • "nextOffset": 40,
  • "totalCount": 200
}

App

アプリ一覧を取得

アプリの一覧を取得

query Parameters
ids
Array of strings <= 200 items

検索するアプリIDのリスト 最大リストサイズ200

query
string

検索するアプリのキーワード (表示名、説明)。
部分一致による検索。

sort
string
Default: "createdAt:desc"
Enum: "id:asc" "id:desc" "name:asc" "name:desc" "displayName:asc" "displayName:desc" "createdAt:asc" "createdAt:desc" "updatedAt:asc" "updatedAt:desc"

ソートする対象 (ID、識別名、表示名、作成日時、更新日時)。
":asc"を指定すると昇順。":desc"を指定すると降順。

offset
integer
Example: offset=20

リストのオフセット

limit
integer [ 1 .. 200 ]
Default: 20
Example: limit=20

リストの上限

header Parameters
X-Spiral-App-Authority
string
Default: use
Enum: "use" "manage"
Example: manage

アプリ権限種別

利用または管理のどちらの立場としてAPIを実行しようとしているのかを指定する ヘッダーの指定を省略した場合、 use （利用）が指定されたものとしてAPIが実行される

Responses

Response Headers
X-Spiral-App-Authority
string
Enum: "use" "manage"
Example: "manage"

アプリ権限種別

Response Schema: application/json
Array of objects

アプリの一覧

prevOffset
integer

前のリストのオフセット。前のリストが存在しない場合はnull

nextOffset
integer

次のリストのオフセット。次のリストが存在しない場合はnull

totalCount
integer

検索結果の全件数

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "prevOffset": 0,
  • "nextOffset": 40,
  • "totalCount": 200
}

アプリを作成

アプリを作成

Request Body schema: application/json
name
string [ 1 .. 64 ] characters

識別名 重複不可 アルファベット大文字・小文字、数字、アンダースコアのみ使用可能 ただし最初の文字はアルファベットでなければならない 未指定の場合、自動発行

displayName
required
string [ 1 .. 64 ] characters

表示名 重複不可

description
string [ 0 .. 512 ] characters

説明

Responses

Response Schema: application/json
id
string

ID

name
string [ 1 .. 64 ] characters

識別名

displayName
string

表示名

description
string

説明

revision
integer

リビジョン。アプリを変更するとカウントアップする数値

version
integer

バージョン

defaultPhpVersion
string
Enum: "7.4" "8.1" "system_default"

現在指定可能なPHPバージョンは7.4, 8.1, system_defaultの３種類。 ※system_defaultは、サービス推奨バージョン

現在のsystem_defaultは8.1。 system_defaultを選択している場合、将来PHPサービス推奨バージョンが更新されると自動的にサービス推奨バージョンを参照します。

object

作成者

object

更新者 更新がないレコードの場合は作成者と同じ

createdAt
string <date-time>

作成日時

Request samples

Content type
application/json
{
  • "name": "app",
  • "displayName": "アプリ",
  • "description": "アプリ説明"
}

Response samples

Content type
application/json
{
  • "id": "100",
  • "name": "app",
  • "displayName": "アプリ",
  • "description": "アプリ説明",
  • "revision": 2,
  • "version": 1,
  • "defaultPhpVersion": "7.4",
  • "createdBy": {
    },
  • "updatedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z"
}

アプリを取得

アプリを取得

path Parameters
appId
required
string

アプリID

header Parameters
X-Spiral-App-Authority
string
Default: use
Enum: "use" "manage"
Example: manage

アプリ権限種別

利用または管理のどちらの立場としてAPIを実行しようとしているのかを指定する ヘッダーの指定を省略した場合、 use （利用）が指定されたものとしてAPIが実行される

Responses

Response Headers
X-Spiral-App-Authority
string
Enum: "use" "manage"
Example: "manage"

アプリ権限種別

Response Schema: application/json
id
string

ID

name
string [ 1 .. 64 ] characters

識別名 重複不可 アルファベット大文字・小文字、数字、アンダースコアのみ使用可能 ただし最初の文字はアルファベットでなければならない 未指定の場合、自動発行

displayName
string

表示名

description
string

説明

revision
integer

リビジョン。アプリを変更するとカウントアップする数値

version
integer

バージョン

defaultPhpVersion
string
Enum: "7.4" "8.1" "system_default"

現在指定可能なPHPバージョンは7.4, 8.1, system_defaultの３種類。 ※system_defaultは、サービス推奨バージョン

現在のsystem_defaultは8.1。 system_defaultを選択している場合、将来PHPサービス推奨バージョンが更新されると自動的にサービス推奨バージョンを参照します。

object

作成者

object

更新者 更新がないレコードの場合は作成者と同じ

createdAt
string <date-time>

作成日時

updatedAt
string <date-time>

更新日時 更新がないレコードの場合は作成日時と同じ

Response Headers
X-Spiral-App-Authority
string
Enum: "use" "manage"
Example: "manage"

アプリ権限種別

Response samples

Content type
application/json
{
  • "id": "100",
  • "name": "Name",
  • "displayName": "アプリ",
  • "description": "アプリ説明",
  • "revision": 2,
  • "version": 1,
  • "defaultPhpVersion": "7.4",
  • "createdBy": {
    },
  • "updatedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

アプリを変更

アプリを変更

path Parameters
appId
required
string

アプリID

Request Body schema: application/json
name
string [ 1 .. 64 ] characters

識別名 重複不可 アルファベット大文字・小文字、数字、アンダースコアのみ使用可能 ただし最初の文字はアルファベットでなければならない

displayName
string [ 1 .. 64 ] characters

表示名 重複不可

description
string [ 0 .. 512 ] characters

説明

defaultPhpVersion
string
Enum: "7.4" "8.1" "system_default"

現在指定可能なPHPバージョンは7.4, 8.1, system_defaultの３種類。 ※system_defaultは、サービス推奨バージョン

現在のsystem_defaultは8.1。 system_defaultを選択している場合、将来PHPサービス推奨バージョンが更新されると自動的にサービス推奨バージョンを参照します。

Responses

Response Schema: application/json
id
string

ID

name
string [ 1 .. 64 ] characters

識別名

displayName
string

表示名

description
string

説明

revision
integer

リビジョン。アプリを変更するとカウントアップする数値

version
integer

バージョン

defaultPhpVersion
string
Enum: "7.4" "8.1" "system_default"

現在指定可能なPHPバージョンは7.4, 8.1, system_defaultの３種類。 ※system_defaultは、サービス推奨バージョン

現在のsystem_defaultは8.1。 system_defaultを選択している場合、将来PHPサービス推奨バージョンが更新されると自動的にサービス推奨バージョンを参照します。

object

作成者

object

更新者 更新がないレコードの場合は作成者と同じ

createdAt
string <date-time>

作成日時

Request samples

Content type
application/json
{
  • "name": "Name",
  • "displayName": "アプリ",
  • "description": "アプリ説明",
  • "defaultPhpVersion": "7.4"
}

Response samples

Content type
application/json
{
  • "id": "100",
  • "name": "app",
  • "displayName": "アプリ",
  • "description": "アプリ説明",
  • "revision": 2,
  • "version": 1,
  • "defaultPhpVersion": "7.4",
  • "createdBy": {
    },
  • "updatedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z"
}

アプリを削除

アプリを削除

path Parameters
appId
required
string

アプリID

Responses

DB

DB一覧を取得

DBの一覧を取得する

path Parameters
app
required
string

アプリID

query Parameters
query
string

検索するDBのキーワード (表示名、説明)。

sort
string
Default: "createdAt:desc"
Enum: "id:asc" "id:desc" "name:asc" "name:desc" "displayName:asc" "displayName:desc" "createdAt:asc" "createdAt:desc" "updatedAt:asc" "updatedAt:desc"

ソートする対象 (ID、識別名、表示名、作成日時、更新日時)。
後に":asc"を入れると昇順。":desc"を入れると降順。

offset
integer
Example: offset=20

リストのオフセット

limit
integer [ 1 .. 200 ]
Default: 20
Example: limit=20

リストの上限

header Parameters
X-Spiral-App-Authority
string
Default: use
Enum: "use" "manage"
Example: manage

アプリ権限種別

利用または管理のどちらの立場としてAPIを実行しようとしているのかを指定する ヘッダーの指定を省略した場合、 use （利用）が指定されたものとしてAPIが実行される

X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

X-Spiral-App-Authority: use の場合にのみ指定が必要

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Authority
string
Enum: "use" "manage"
Example: "manage"

アプリ権限種別

X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
Array of objects

DBの一覧

prevOffset
integer

前のリストのオフセット。前のリストが存在しない場合はnull

nextOffset
integer

次のリストのオフセット。次のリストが存在しない場合はnull

totalCount
integer

検索結果の全件数

Response Headers
X-Spiral-App-Authority
string
Enum: "use" "manage"
Example: "manage"

アプリ権限種別

X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "prevOffset": 0,
  • "nextOffset": 40,
  • "totalCount": 200
}

DBを作成

DBを作成

path Parameters
app
required
string

アプリID

Request Body schema: application/json
name
string [ 1 .. 64 ] characters

識別名 アプリ内で重複不可 アルファベット大文字・小文字、数字、アンダースコアのみ使用可能 ただし最初の文字はアルファベットでなければならない 未指定の場合、自動発行

displayName
required
string [ 1 .. 64 ] characters

DB表示名 アプリ内で重複不可

description
string [ 0 .. 512 ] characters

DB説明

Array of objects

フィールドのリスト

Responses

Response Schema: application/json
id
string

DBID

name
string [ 1 .. 64 ] characters

識別名 重複不可 アルファベット大文字・小文字、数字、アンダースコアのみ使用可能 ただし最初の文字はアルファベットでなければならない 未指定の場合、自動発行

displayName
string [ 1 .. 64 ] characters

DB表示名

description
string [ 0 .. 512 ] characters

DB説明

revision
string

DBリビジョン

Array of objects

フィールド一覧

object

作成者

object

更新者 更新がないレコードの場合は作成者と同じ

createdAt
string <date-time>

作成日時

updatedAt
string <date-time>

更新日時 更新がないレコードの場合は作成日時と同じ

Request samples

Content type
application/json
{
  • "name": "inquirydb",
  • "displayName": "問い合わせ管理DB",
  • "description": "問い合わせを管理するDBです。",
  • "fields": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "100",
  • "name": "inquirydb",
  • "displayName": "問い合わせ管理DB",
  • "description": "問い合わせを管理するDBです",
  • "revision": "1",
  • "fields": [
    ],
  • "createdBy": {
    },
  • "updatedBy": {
    },
  • "createdAt": "2021-01-28T03:57:23Z",
  • "updatedAt": "2021-01-28T03:57:23Z"
}

DBを取得

DBを取得

path Parameters
app
required
string

アプリID

db
required
string

DBID

header Parameters
X-Spiral-App-Authority
string
Default: use
Enum: "use" "manage"
Example: manage

アプリ権限種別

利用または管理のどちらの立場としてAPIを実行しようとしているのかを指定する ヘッダーの指定を省略した場合、 use （利用）が指定されたものとしてAPIが実行される

X-Spiral-App-Role
string
Default: _fullAccess
Example: employee

アプリロール

X-Spiral-App-Authority: use の場合にのみ指定が必要

ヘッダーの指定を省略した場合、「全権限」のアプリロールが指定されたものとしてAPIが実行される
リクエストしたユーザ・APIエージェントが権限を持たないアプリロールを指定された場合はエラーとなる

Responses

Response Headers
X-Spiral-App-Authority
string
Enum: "use" "manage"
Example: "manage"

アプリ権限種別

X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response Schema: application/json
id
string

DBID

name
string [ 1 .. 64 ] characters

識別名 重複不可 アルファベット大文字・小文字、数字、アンダースコアのみ使用可能 ただし最初の文字はアルファベットでなければならない 未指定の場合、自動発行

displayName
string [ 1 .. 64 ] characters

DB表示名

description
string [ 0 .. 512 ] characters

DB説明

revision
string

DBリビジョン

Array of objects

フィールド一覧

object

作成者

object

更新者 更新がないレコードの場合は作成者と同じ

createdAt
string <date-time>

作成日時

updatedAt
string <date-time>

更新日時 更新がないレコードの場合は作成日時と同じ

Response Headers
X-Spiral-App-Authority
string
Enum: "use" "manage"
Example: "manage"

アプリ権限種別

X-Spiral-App-Role
string
Example: "employee"

アプリロール

Response samples

Content type
application/json
{
  • "id": "100",
  • "name": "inquirydb",
  • "displayName": "問い合わせ管理DB",
  • "description": "問い合わせを管理するDBです",
  • "revision": "1",
  • "fields": [
    ],
  • "createdBy": {
    },
  • "updatedBy": {
    },
  • "createdAt": "2021-01-28T03:57:23Z",
  • "updatedAt": "2021-01-28T03:57:23Z"
}

DBを変更

指定のDBを変更する

path Parameters
app
required
string

アプリID

db
required
string

DBID

Request Body schema: application/json
name
string [ 1 .. 64 ] characters

識別名 アプリ内で重複不可 アルファベット大文字・小文字、数字、アンダースコアのみ使用可能 ただし最初の文字はアルファベットでなければならない

displayName
string [ 1 .. 64 ] characters

DB表示名 アプリ内で重複不可

description
string [ 0 .. 512 ] characters

DB説明

revision
string

DBリビジョン。 変更元のリビジョンを指定する。 指定されたリビジョンが最新のものでない場合はエラー。 指定しない場合はチェックを行わない。

Array of objects

追加するフィールドの配列

Array of objects

更新するフィールドの配列

deleteFields
Array of strings

削除するフィールドのフィールドID、あるいはフィールド識別名の配列 multipleUnique で指定されているフィールドは削除不可

fieldOrder
Array of strings

フィールドの並び順をフィールド識別名にて配列の並び順で指定。
一部のフィールドのみを指定した場合は、配列の先頭に指定されたフィールドの位置に合わせて並びかえる。
更新後に存在しないフィールド識別名を指定するとエラー。
１フィールドのみを指定した場合は、並び順は変わらない。

Responses

Response Schema: application/json
id
string

DBID

name
string [ 1 .. 64 ] characters

識別名 重複不可 アルファベット大文字・小文字、数字、アンダースコアのみ使用可能 ただし最初の文字はアルファベットでなければならない 未指定の場合、自動発行

displayName
string [ 1 .. 64 ] characters

DB表示名

description
string [ 0 .. 512 ] characters

DB説明

revision
string

DBリビジョン

Array of objects

フィールド一覧

object

作成者

object

更新者 更新がないレコードの場合は作成者と同じ

createdAt
string <date-time>

作成日時

updatedAt
string <date-time>

更新日時 更新がないレコードの場合は作成日時と同じ

Request samples

Content type
application/json
{
  • "name": "inquirydb",
  • "displayName": "問い合わせ管理DB",
  • "description": "問い合わせを管理するDBです",
  • "revision": "1",
  • "addFields": [
    ],
  • "updateFields": [
    ],
  • "deleteFields": [
    ],
  • "fieldOrder": [
    ],
  • "multipleUnique": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "100",
  • "name": "inquirydb",
  • "displayName": "問い合わせ管理DB",
  • "description": "問い合わせを管理するDBです",
  • "revision": "1",
  • "fields": [
    ],
  • "createdBy": {
    },
  • "updatedBy": {
    },
  • "createdAt": "2021-01-28T03:57:23Z",
  • "updatedAt": "2021-01-28T03:57:23Z"
}

DBを削除

指定のDBを削除する DBに依存する設定がある場合は削除できずにエラーとなる 一部の設定はDB削除時に連動して削除される場合がある 詳細はサポートサイトをご確認ください

path Parameters
app
required
string

アプリID

db
required
string

DBID

Responses

Action

アクションを実行

アクションを実行する

path Parameters
app
required
string

アプリID

actionId
required
string

アクションID

Request Body schema: application/json

アクション毎に異なる。
詳細はサポートサイトをご確認ください。

object

Responses

Request samples

Content type
application/json
{ }

Authentication

認証エリアにログイン

本番環境の認証エリアにログインしてセッションに紐づくエリア認証トークンを発行する エリア認証トークンの有効期限は認証エリアで設定したセッション有効期限に準ずる APIエージェントのみ使用可能

path Parameters
siteId
required
string

サイトID

authenticationId
required
string

認証エリアID

Request Body schema: application/json
id
required
string

認証エリアで指定されたIDフィールドの値

password
required
string

認証エリアで指定されたパスワードフィールドの値

Responses

Response Schema: application/json
recordId
string

ID・パスワードによって認証したレコードID

token
string

エリア認証トークン

expireTime
integer

エリア認証トークンの有効期限日時（エポック秒）

Request samples

Content type
application/json
{
  • "id": "spiral.taro",
  • "password": "7jSkFW5,.T_D~hE"
}

Response samples

Content type
application/json
{
  • "recordId": "100",
  • "token": "59220e7f-b813-47d8-8a1e-95cacd88a13e",
  • "expireTime": 1588266389
}

エリア認証トークンの有効性確認

セッションに紐づくエリア認証トークンの有効性を確認する 指定するエリア認証トークンを発行したAPIエージェントのみ使用可能 デフォルトで有効性確認と同時にセッションの有効期限を延長する

path Parameters
siteId
required
string

サイトID

authenticationId
required
string

認証エリアID

Request Body schema: application/json
token
required
string

エリア認証トークン

extendExpireTime
boolean
Default: true

エリア認証トークンの有効期限の延長 延長時間は認証エリアで設定したセッション有効期限に準ずる trueの場合は有効期限を延長する

Responses

Response Schema: application/json
status
boolean

エリア認証トークンの有効性 有効の場合はtrueを返す 無効の場合はfalseを返す

expireTime
integer

エリア認証トークンの有効期限日時（エポック秒） stautsがfalseの場合はnull

Request samples

Content type
application/json
{
  • "token": "59220e7f-b813-47d8-8a1e-95cacd88a13e",
  • "extendExpireTime": true
}

Response samples

Content type
application/json
{
  • "status": true,
  • "expireTime": 1588266389
}

認証エリアログインのワンタイムURL発行

有効なエリア認証トークンを用いて認証エリアにブラウザでログインするためのワンタイムURLを発行する ワンタイムURLは一度アクセスすると無効化され再アクセスできなくなる 指定するエリア認証トークンを発行したAPIエージェントのみ使用可能

path Parameters
siteId
required
string

サイトID

authenticationId
required
string

認証エリアID

Request Body schema: application/json
token
required
string

エリア認証トークン 無効の場合はエラーとなる

path
required
string

ログイン後に表示する認証エリアのページパス ログインAPIでログインした認証エリアのみ指定可能

Responses

Response Schema: application/json
url
string

指定したページパスにログインするためのクエリパラメータ付きURL 有効期間はURLが発行されてから1分間 1度アクセスされるか、ページパスに関係なく同一のエリア認証トークンで新たにURLが発行されると無効になる

Request samples

Content type
application/json
{
  • "token": "59220e7f-b813-47d8-8a1e-95cacd88a13e",
  • "path": "/memberAuth/update"
}

認証エリアからログアウト

本番環境の認証エリアからログアウトする ログアウトするとエリア認証トークンは無効となる ワンタイムURLで認証エリアにログインしている場合もログアウトされる 指定するエリア認証トークンを発行したAPIエージェントのみ使用可能

path Parameters
siteId
required
string

サイトID

authenticationId
required
string

認証エリアID

Request Body schema: application/json
token
required
string

エリア認証トークン 無効の場合はエラーとなる

Responses

Request samples

Content type
application/json
{
  • "token": "59220e7f-b813-47d8-8a1e-95cacd88a13e"
}