Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

これは、RESTコール(GET、POST、PUT、PATCH、DELETE)を使用して管理システムと相互作用する可能性を文書化したもので、プロジェクトやユーザーを作成するようなタスクの自動化を可能にします。

...

リソース

メソッド

説明

/node/logins

GET

過去5年間のプロジェクトのログイン統計を、クライアントの使用タイプ(Revit、dRofusなど)別にグループ化して取得します。

/node/logins?from_date=2018-01-01&to_date=2019-12-31

GET

指定された期間のプロジェクトのログイン統計情報を、使用しているクライアントのタイプごとにグループ化して取得します (Revit、dRofusなど)。

/node/unique_users

GET

過去5年間の各プロジェクトのユニーク・ユーザー数を取得します。

/node/unique_users?from_date=2018-01-01&to_date=2019-12-31

GEt

指定された期間における各プロジェクトのユニークユーザー数を取得します。

/project_data?from_date=2018-01-01&to_date=2019-12-31

GEt

プロジェクトの統計値を取得、to_dateとfrom_dateは、日付のオプション制限です。

/password/request_reset

GET

有効なユーザー名でのポスト リクエストは、パスワードリセットメールをトリガーします。

/password/reset

GET

APIでパスワードを変更するには、トークンとともにこれを使用します。

/owners/[id]/tasks/[TaskName]/run?source=[sourcedb]&copy_ids=[ids]

POST

特定の所有者の全データベースに対して特定のタスクを実行します。タスク名 (TaskName)は以下のいずれかです。

  • CopyOverwriteExcelExportsTask: idで識別される、指定されたExcel
    エクスポートを、sourcedbから他のすべてのdbにコピーします。

  • CopySharedRdlReports: idで識別される指定されたRDLレポートを、sourcedbから他のすべてのdbにコピーします。

...

リソース

説明

パラメータ

/projects

すべてのプロジェクトをリスト

?query=xx will list all projects contaning xx in the nameは、プロジェクト名に xx を含むすべてのプロジェクトをリストアップします。

?show_all=1 to also include inactive projects活動休止中のプロジェクトも含める。

/projects/1

id 1のプロジェクトをリスト

/owners

すべての所有者をリスト

/owners/1

所有者を id 1 でリスト

/users

全ユーザーのリスト

?query=xx to searchxxを検索する。

/users/username

ユーザー名でユーザーをリスト

/database

データベースのリスト

/project_users/username,projectid

プロジェクトユーザーを表示

...

新規プロジェクトの作成 (POST/projects)

新しいプロジェクトを作成するには、いくつかの特別なパラメータが必要です。新しいプロジェクトを作成する際に提供する最小限のデータは以下の通りです。新しいプロジェクトを作成するには、いくつかの特別なパラメータが必要です。新しいプロジェクトを作成する際に、最低限必要なデータは以下の通りです。

パラメータ

説明

new_db

1 to create a new database or 0 to add project to an existing database

新しいデータベースを作成する場合は1、既存のデータベースにプロジェクトを追加する場合は0。

new_db_template

If creating a new database, provide the database name that would be used as a template

新しいデータベースを作成する場合は、テンプレートとして使用するデータベース名を指定。

new_db_name

If creating a new database, provide the name of the new database

新しいデータベースを作成する場合は、新しいデータベースの名前を入力してください。

existing_db_name

If NOT creating a new database (new_db set to 0) provide the name of the existing database to add the new project to

新しいデータベースを作成しない場合(new_dbを0に設定)、新しいプロジェクトを追加する既存のデータベース名を指定。

name

Name of the project

プロジェクト名。

constructor

Name of the constructor/firm of the new project

新規プロジェクトの施工者 (建設者)/会社名。

description

Description of the project

プロジェクトの内容。

owner_id

ID of the owner

所有者 (オーナー) のID。

project_type_id

Type of project. Use one of the following values    

プロジェクトのタイプ。以下の値のいずれかを使用します。

id

│ name

│ 名前
─┼────────────────────
1 │ Active Project (有効なプロジェクト)
2 │ Deprecated Project (現在休止中のプロジェクト)
3 │ Demo (デモ)
4 │ Copy / Backup (コピー/バックアップ)
5 │ Template (テンプレート)
6 │ Sandbox / Test (サンドボックス/テスト)
7 │ Training (トレーニング)
8 │ Trial (トライアル)

すべてのパラメータは必須です。

Code Block
{
  "project": {
    "new_db": "1",
    "new_db_template": "dev-template",
    "new_db_name": "rest_test",
	"project_type_id": 1, 
    "name": "REST TEST",
    "owner_id": 5,
    "description": "TEST CREATE FROM REST",
    "constructor" : "dRofus AS"
  }
}

...