ver.2サポートサイト

・参照先に指定できるDBは同一アプリ内の別DBのみとなります。

・参照先に指定したDBのレコードをラベルとして表示することができます。

・選択できるフィールドは、入力必須かつユニークのテキストフィールド・メールアドレスフィールド、またはレコードIDのみとなります。

入力は参照先DBのレコードIDのみです。

{
"info": {
"url": "https://api.spiral-platform.com/v1/dbs/123/records?referrer=123.4:56"
},
"value": {
"_id": "1",
"_revision": "10",
"_createdBy": {
"type": "user",
"userId": "100"
},
"_createdAt": "2020-04-30T17:06:29Z",
"_createOperationSourceId": "100",
"_updatedBy": {
"type": "user",
"userId": "100"
},
"_updatedAt": "2020-04-30T17:06:29Z",
"_updateOperationSourceId": "100",
"_unauthorized": "false",
"email": "yamada@example.com"
}
}

参照先レコードを取得するための情報、参照先レコード値(メタ情報やラベルフィールド)を出力します。

※サブラベルフィールド値は出力されません。

・infoで取得するURLは、参照先レコードを取得するためのリクエストURLです。

referrer=123.4:56で参照元から参照されているレコードを絞り込みます。

※[参照元DB ID].[参照フィールドID]:[参照元レコードID]のフォーマット形式になります。

・1レコード参照の参照先レコード値の場合、1件のオブジェクト、複数レコード参照の参照先レコード値の場合、オブジェクトのリストを返します。

レコードID|リビジョン番号|登録者|登録日時|登録操作元ID|更新者|更新日時|更新操作元ID|閲覧権限可否|フィールド値

{
"info": {
"url": "https://api.spiral-platform.com/v1/dbs/123/records?referrer=123.4:56"
},
"value": [
{
"_id": "1",
"_revision": "10",
"_createdBy": {
"type": "user",
"userId": "100"
},
"_createdAt": "2020-04-30T17:06:29Z",
"_createOperationSourceId": "100",
"_updatedBy": {
"type": "user",
"userId": "100"
},
"_updatedAt": "2020-04-30T17:06:29Z",
"_updateOperationSourceId": "100",
"_unauthorized": "false",
"shopName": "赤坂店"
},
{
"_id": "3",
"_revision": "10",
"_createdBy": {
"type": "user",
"userId": "100"
},
"_createdAt": "2020-04-30T17:06:29Z",
"_createOperationSourceId": "100",
"_updatedBy": {
"type": "user",
"userId": "100"
},
"_updatedAt": "2020-04-30T17:06:29Z",
"_updateOperationSourceId": "100",
"shopName": "青山店"
}
]
}

1レコード参照

赤坂店

10

入力形式は、参照先DBの入力必須かつユニークのテキスト、メールアドレスフィールドのラベルフィールド値、参照先レコードID

複数レコード参照

赤坂店|青山店|丸の内店|下北沢店

10|12|15|19

入力形式は、参照先DBの入力必須かつユニークのテキスト、メールアドレスフィールドのラベルフィールド値、参照先レコードID

※参照先のレコード値に|が含まれている場合、レコード値全体を""でくくります。

1レコード参照

赤坂店

10

ラベルフィールド値で出力した場合で、参照先レコードの閲覧権限がない場合は(_unauthorized:XX)で出力します。

※サブラベルフィールド値は出力されません。

複数レコード参照

赤坂店|青山店|丸の内店|下北沢店

10|12|15|19

ラベルフィールド値で出力した場合で、参照先レコードの閲覧権限がない場合は(_unauthorized:XX)で出力します。

※サブラベルフィールド値は出力されません。

参照先DBのレコードを1件のみ関連付けするか、複数レコードを関連付けするかを選択します。

複数レコードを参照する場合、1～20件の範囲で指定できます。

なお、設定済みの参照レコード数を1レコード参照から複数レコード参照へ変更することはできません。

参照先DBのレコードをラベルとして表示するフィールドを選択します。

ラベルにできるフィールドは、入力必須かつユニークのテキストフィールド・メールアドレスフィールド、またはレコードIDのみとなります。

参照先DBのレコードが削除された場合の参照フィールド上の値の取り扱いを指定します。

参照先DBのレコードを削除禁止、または、参照先レコードが削除した場合、参照元レコードの値はnullにするかを選択します。