出典

更新しました

ソースは、サービスからのデータのソースを表します。たとえば、iCloudアカウントはiCloudサービスのソースです。

ソースは、個別にターゲットにできる複数のrirelay.sourceソースを持つrirelay.instanceソースなどの子ソースを持つことができます。

属性

タイプ説明
id ソースID リソース識別子
resource 文字列、常にsource リソースタイプ指定子
user ユーザーID このソースに関連付けられているユーザー。
type ストリングこのソースのタイプ(例: icloud.account
identifier ストリングサービスのスコープ内のソースの一意の識別子。
parent オプション、ソースID ソースが他の子である場合は設定されます。
children ソースリソースを含むリストオブジェクト ソースサブソースが含まれます。
state ひも unvalidatedactivedeactivatedblockedlockedです。
date_created 日付時刻リソースが作成されたとき

タイプ

現在サポートされているタイプは次のとおりです。

  • icloud.accountは、iCloudサービスの主要なソースです。
  • rirelay.instance 、rirelayサービスの主要なソース。 Reincubate Relayアプリケーションのインスタンスに対応します。
  • rirelay.sourceの子ソースであるrirelay.instance 。親のReincubate Relayアプリがアクセスできるデバイスに対応します。

識別子

ソースのidentifier属性の値は、サービス内で一意にidentifierます。 iCloudアカウントの場合、これはユーザー名になります。 Reincubate Relayアプリインスタンスの場合は、インスタンスIDになります。

ソースが子ソースの場合、このフィールドはその親ソースオブジェクトを指します。この階層のトップソースはプライマリソースと呼ばれます。

子ソースはAPIを介して直接作成することはできませんが、適切なポーリングが作成されたときにAPIによって自動的に作成されます。

unvalidated
このソースに対してセッションが正常に作成されたことがないため、APIはそれが有効なソースかどうかを判断できません。
active
ソースは検証済みであり、使用可能です。
deactivated
ソースへのアクセスは所有組織によって禁止されています。
blocked
ソースへのアクセスはAPI管理者によって禁止されています。
locked
ソースへのアクセスは一時的に外部サービスによって制限されています。

GET /sources/{source ID}取得しGET /sources/{source ID}

cURLを使う

curl https://ricloud-api.reincubate.com/sources/<source ID> \
  -H 'Authorization: Token <your key_token>'

ricloud-pyを使う

import ricloud

source = ricloud.Source.create(<source ID>)

サンプル応答

{
  "id": 1,
  "resource": "source",
  "user": 1,
  "type": "mocks.mock",
  "identifier": "john.appleseed@reincubate.com",
  "info": null,
  "parent": null,
  "children": {
      "data": [],
      "has_more": false,
      "total_count": 0,
      "url": "/sources/1/children"
  },
  "state": "active",
  "date_created": "2020-02-20T11:59:03.195527Z"
}

GET /sources一覧表示する

タイプ説明
organisation スーパー、組織ID API管理者が組織でフィルタリングするためのものです。
user ユーザーID 関連付けられたユーザーでフィルタします。
type ひもソースタイプでフィルタします。
identifier ひもソース識別子でフィルタします。
state ひもソースの状態でフィルタします。
date_created 日時フィルターリソース作成日でフィルタします。

cURLを使う

curl https://ricloud-api.reincubate.com/sources \
  -H 'Authorization: Token <your key_token>'

ricloud-pyを使う

import ricloud

sources = ricloud.Source.list()

POST /sources/{source ID}更新します

名前タイプ解説
state ストリングソースの状態を更新します。

cURLを使う

curl https://ricloud-api.reincubate.com/sources/<source ID> \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "state": "deactivated"
}'

ricloud-pyを使う

import ricloud

source = ricloud.Source.update_with_id(<source ID>, state='deactivated')

# OR

source = ricloud.Source.retrieve(<source ID>)

source.update(state='deactivated')

変更ログ

2020-02-20

  • Majorソースオブジェクトのchildren属性は、単純なリスト属性ではなく、ネストされたリストオブジェクトになりました。

2019-10-16

  • 2つの新しいソースタイプrirelay.instancerirelay.sourceます。

どのように我々は助けることができます?

サポートチームがお手伝いします!

営業時間は月曜日から金曜日の午前9時から午後5時(GMT)です。 時間は現在 7:09 PM GMTです。

1営業日以内に、お返事を差し上げます。メールアドレスはこちら。

私たちの素晴らしいサポートチーム

© 2008 - 2024 Reincubate Ltd. 無断複写・転載を禁じます。 イングランドとウェールズに登録 #5189175, VAT GB151788978. Reincubate®およびCamo®は登録商標です。 個人情報保護方針 & 条項.