コレクションエンドポイント
コレクションエンドポイントとパラメーター
オブジェクト関係に関する詳細とAPIでの使用方法については、 オブジェクト関係 のセクションを参照してください。
コレクションの詳細については、 コレクション のヘルプページを参照してください。
新しいコレクションを作成する
コレクションを作成するには、
POST {baseURL}/v3/collections
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。このエンドポイントを使用するには、認証されたAPIユーザーに「コレクションの作成」権限が必要です。権限がない場合、401認証エラーが返されます。
パラメーター
contract (本文): コレクションを作成するには、contractパラメーターが必要になります。コレクションを作成するには、次のように指定します。
name (文字列): 必須です。コレクション名を指定します。
リクエストの例: cURL
curl --location --request POST 'http://localhost/webapi//v3/collections' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Accounting'
ユーザーをコレクションに追加する
既存のコレクションにユーザーを追加するには、
POST {baseURL}/v3/collections/{collectionId}/users
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
collectionId (文字列): 必須です。コレクションIDを入力して、ユーザーを追加するコレクションを指定します。
addUsersContract (本文): 必須です。ユーザーとその権限に関する情報を入力します。ユーザーをコレクションに追加するには、次のように指定します。
userId (文字列): 必須です。コレクションに追加するユーザーのIDを指定します。
expirationDate (文字列): オプションです。コレクションメンバーとしてのユーザーの有効期限を指定します。日付と時刻を ISO8601形式 で入力します。
collectionsPermissions (本文):
isAdmin (ブール型): 必須です。そのユーザーをコレクションの管理者にするかどうかを指定します。
canAddAssets (ブール型): 必須です。そのユーザーがコレクションにアセットを追加できるかどうかを指定します。
canUpdateAssets (ブール型): 必須です。そのユーザーがコレクション内のアセットを更新できるかどうかを指定します。
canRemoveAssets (ブール型): 必須です。そのユーザーがコレクションからアセットを削除できるかどうかを指定します。
canAddUsers (ブール型): オプションです。そのユーザーがコレクションに他のユーザーを追加できるかどうかを指定します。
canRemoveUsers (ブール型): オプションです。そのユーザーがコレクションから他のユーザーを削除できるかどうかを指定します。
ロールと権限の詳細については、 ユーザーロールと権限 のページを参照してください。ロールが選択されていない場合、既定は、Server管理者が 管理者インターフェース で指定した既定のロールになります。
リクエストの例: cURL
curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/users' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'userId=61d80f862835728c94328082' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'canAddAssets=true' \ --data-urlencode 'canRemoveAssets=true' \ --data-urlencode 'canUpdateAssets=true' \ --data-urlencode 'canAddUsers=true' \ --data-urlencode 'canRemoveUsers=true' \ --data-urlencode 'expirationDate=2007-08-17T19:18:11.924Z'
スケジュールをコレクションに追加する
既存のコレクションにスケジュールを追加するには、
POST {baseURL}/v3/collections/{collectionId}/schedules
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
collectionId (文字列): 必須です。コレクションIDを入力して、スケジュールを追加するコレクションを指定します。
contract (本文): 必須です。スケジュールに関する情報を入力します。次の項目を指定します。
scheduleId (文字列): 必須です。コレクションに追加するスケジュールIDを指定します。
リクエストの例: cURL
curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/schedules' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'scheduleId=61d80f334528377728c94328082'
ワークフローをコレクションに追加する
ワークフローを既存のコレクションに追加するには、
POST {baseURL}/v3/collections/{collectionId}/workflows
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
collectionId (文字列): 必須です。コレクションIDを入力して、インサイトを追加するコレクションを指定します。
contract (本文): 必須です。ユーザーとその権限に関する情報を入力します。次の項目を指定します。
workflowId (文字列): 必須です。コレクションに追加するワークフローIDを指定します。
リクエストの例: cURL
curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/workflows' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'workflowId=61d80f334223377728c9432'
ユーザーグループをコレクションに追加する
ユーザーグループを既存のコレクションに追加するには、
POST {baseURL}/v3/collections/{collectionId}/userGroups
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
collectionId (文字列): 必須です。コレクションIDを入力して、ユーザーグループを追加するコレクションを指定します。
addUserGroupsContract (本文): 必須です。ユーザーグループとその権限に関する情報を入力します。次の項目を指定します。
userGroupId (文字列): 必須です。コレクションに追加するユーザーグループのIDを指定します。
expirationDate (文字列): オプションです。コレクションメンバーとしてのユーザーグループの有効期限を指定します。ユーザーが作成された後の日付と時刻を ISO8601形式 で入力します。
collectionsPermissions (本文): 必須です。
isAdmin (ブール型): オプションです。そのユーザーグループメンバーをコレクションの管理者にするかどうかを指定します。既定値はfalseです。
canAddAssets (ブール型): オプションです。そのユーザーグループメンバーがコレクションにアセットを追加できるかどうかを指定します。既定値はfalseです。
canRemoveAssets (ブール型): オプションです。そのユーザーグループメンバーがコレクションからアセットを削除できるかどうかを指定します。既定値はfalseです。
canUpdateAssets (ブール型): オプションです。そのユーザーグループメンバーがコレクション内のアセットを更新できるかどうかを指定します。既定値はfalseです。
canAddUsers (ブール型): オプションです。そのユーザーグループメンバーが他のユーザーをコレクションに追加できるかどうかを指定します。既定値はfalseです。
canRemoveUsers (ブール型): 必須です。そのユーザーグループメンバーがコレクションから他のユーザーを削除できるかどうかを指定します。既定値はfalseです。
ロールと権限の詳細については、 ユーザーロールと権限 のページを参照してください。ロールが選択されていない場合、既定は、Server管理者が 管理者インターフェース で指定した既定のロールになります。
リクエストの例: cURL
curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/userGroups?addUserGroupsContract' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'userGroupId=61d83e2ef778247f14e8e6b6' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'canAddAssets=false' \ --data-urlencode 'canRemoveAssets=true' \ --data-urlencode 'canUpdateAssets=false' \ --data-urlencode 'canAddUsers=true' \ --data-urlencode 'canRemoveUsers=true'
コレクションレコードを取得する
既存のコレクションの詳細を取得するには、
GET {baseURL}/v3/collections/{collectionId}
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
collectionId (文字列): 必須です。コレクションIDを入力して、コレクションに関する情報を取得します。
リクエストの例: cURL
curl --location --request GET 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c' \ --header 'Authorization: Bearer BearerTokenGoesHere'
すべてのコレクションレコードを取得する
アクセス可能なすべてのコレクションレコードを取得するには、
GET {baseURL}/v3/collections
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
view (文字列): オプションです。値を指定しないこともできます。値は「Default」(既定)と「Full」(完全)から選択できます。このパラメーターを「Default」(既定)に設定すると、縮小表示オブジェクトが返されます。指定しない場合は、「Default」(既定)の値が使用されます。
リクエストの例: cURL
curl --location --request GET 'http://localhost/webapi/v3/collections?view=Full' \ --header 'Authorization: Bearer BearerTokenGoesHere'
既存のコレクションを更新する
既存のコレクションの名前や所有者を更新するには、
PUT {baseURL}/v3/collections/{collectionId}
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
collectionId (文字列): 必須です。コレクションIDを入力して、更新するコレクションを指定します。
updateCollectionContract (本文): 必須です。変更するコレクション所有者に関する情報を入力します。次の項目を指定します。
name (文字列): 必須です。コレクションの新しい名前を入力します。
ownerId (文字列): 必須です。新しい所有者のIDを入力します。
リクエストの例: cURL
curl --location --request PUT 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Accounting' \ --data-urlencode 'ownerId=61db388fc565144387d45086'
コレクションのユーザー権限を更新する
既存のコレクション内のユーザー権限を更新するには、
PUT {baseURL}/v3/collections/{collectionId}/users/{userId}/permissions
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。Windows認証が設定されたServerインスタンスの場合は、userIdパラメーターにActive Directory Sidを指定します。
パラメーター
collectionId (文字列): 必須です。コレクションIDを入力して、更新するコレクションを指定します。
userId (文字列): 必須です。権限を変更するユーザーIDを入力します。
updatePermissionsContract (本文): 必須です。権限を変更するユーザーIDを入力します。次の項目を指定します。
expirationDate (日付): 必須です。ユーザーの有効期限を指定します。
collectionsPermissions (本文): 必須です。新しい所有者のユーザーIDを入力します。次の項目を指定します。
isAdmin (ブール型): 必須です。そのユーザーをコレクションの管理者にするかどうかを指定します。
canAddAssets (ブール型): 必須です。そのユーザーがコレクションにアセットを追加できるかどうかを指定します。
canRemoveAssets (ブール型): 必須です。そのユーザーがコレクションからアセットを削除できるかどうかを指定します。
canUpdateAssets (ブール型): 必須です。そのユーザーがコレクション内のアセットを更新できるかどうかを指定します。
canAddUsers (ブール型): 必須です。そのユーザーがコレクションに他のユーザーを追加できるかどうかを指定します。
canRemoveUsers (ブール型): 必須です。そのユーザーがコレクションから他のユーザーを削除できるかどうかを指定します。
ロールと権限の詳細については、 ユーザーロールと権限 のページを参照してください。ロールが選択されていない場合、既定は、Server管理者が 管理者インターフェース で指定した既定のロールになります。
リクエストの例: cURL
curl --location --request PUT 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/users/61db388fc565144387d45086/permissions' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'canAddAssets=true' \ --data-urlencode 'canRemoveAssets=true' \ --data-urlencode 'canUpdateAssets=true' \ --data-urlencode 'canAddUsers=true' \ --data-urlencode 'canRemoveUsers=true'
コレクションのユーザーグループ権限を更新する
既存のコレクション内のユーザーグループ権限を更新するには、
PUT {baseURL}/v3/collections/{collectionId}/userGroups/{userGroupId}/permissions
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
collectionId (文字列): 必須です。コレクションIDを入力して、更新するコレクションを指定します。
userGroupId (文字列): 必須です。権限を変更するユーザーグループIDを入力します。
updatePermissionsContract (本文): 必須です。権限を変更するユーザーグループIDを入力します。次の項目を指定します。
expirationDate (日付): オプションです。ユーザーグループの有効期限を指定します。
collectionsPermissions (本文): 必須です。次の項目を指定します。
isAdmin (ブール型): 必須です。そのユーザーグループメンバーをコレクションの管理者にするかどうかを指定します。
canAddAssets (ブール型): 必須です。そのユーザーグループメンバーがコレクションにアセットを追加できるかどうかを指定します。
canRemoveAssets (ブール型): 必須です。そのユーザーグループメンバーがコレクションからアセットを削除できるかどうかを指定します。
canUpdateAssets (ブール型): 必須です。そのユーザーグループメンバーがコレクション内のアセットを更新できるかどうかを指定します。
canAddUsers (ブール型): 必須です。そのユーザーグループメンバーが他のユーザーをコレクションに追加できるかどうかを指定します。
canRemoveUsers (ブール型): 必須です。そのユーザーグループメンバーがユーザーをコレクションから削除できるかどうかを指定します。
ロールと権限の詳細については、 ユーザーロールと権限 のページを参照してください。ロールが選択されていない場合、既定は、Server管理者が 管理者インターフェース で指定した既定のロールになります。
リクエストの例: cURL
curl --location --request PUT 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/userGroups/61db38834tssrdrs4cc65144387d4508/permissions' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'canAddAssets=true' \ --data-urlencode 'canRemoveAssets=false' \ --data-urlencode 'canUpdateAssets=true' \ --data-urlencode 'canAddUsers=true' \ --data-urlencode 'canRemoveUsers=true'
ユーザーをコレクションから削除する
ユーザーを既存のコレクションから削除するには、
DELETE {baseURL}/v3/collections/{collectionId}/users/{userId}
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
collectionId (文字列): 必須です。コレクションIDを入力して、更新するコレクションを指定します。
userId (文字列): 必須です。コレクションから削除するユーザーIDを入力します。
リクエストの例: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/users/61db388fc565144387d45086' \ --header 'Authorization: Bearer BearerTokenGoesHere'
ワークフローをコレクションから削除する
ワークフローを既存のコレクションから削除するには、
DELETE {baseURL}/v3/collections/{collectionId}/workflows/{appId}
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
collectionId (文字列): 必須です。コレクションIDを入力して、更新するコレクションを指定します。
appId (文字列): 必須です。コレクションから削除するワークフローIDを入力します。
リクエストの例: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/workflows/61db388fc565144387d45086' \ --header 'Authorization: Bearer BearerTokenGoesHere'
スケジュールをコレクションから削除する
スケジュールを既存のコレクションから削除するには、
DELETE {baseURL}/v3/collections/{collectionId}/schedules/{scheduleId}
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
collectionId (文字列): 必須です。コレクションIDを入力して、更新するコレクションを指定します。
scheduleId (文字列): 必須です。コレクションから削除するスケジュールIDを入力します。
リクエストの例: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/schedules/61db3777c565144387d450867' \ --header 'Authorization: Bearer BearerTokenGoesHere'
ユーザーグループをコレクションから削除する
ユーザーグループを既存のコレクションから削除するには、
DELETE {baseURL}/v3/collections/{collectionId}/userGroups/{userGroupId}
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
collectionId (文字列): 必須です。コレクションIDを入力して、更新するコレクションを指定します。
userGroupId (文字列): 必須です。コレクションから削除するユーザーグループIDを入力します。
リクエストの例: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/userGroups/61dc063d9938fe43b5e8fc80' \ --header 'Authorization: Bearer BearerTokenGoesHere'
コレクションを削除する
コレクションを削除するには、
DELETE {baseURL}/v3/collections/{collectionId}
エンドポイントを使用します。
注記
このAPIエンドポイントを使用できるのは管理者のみです。
パラメーター
collectionId (文字列): 必須です。コレクションIDを入力して、更新するコレクションを指定します。
forceDelete (ブール型): オプションです。コレクションに、ユーザー、グループ、ワークフロー、インサイト、スケジュールなどの他のオブジェクトへのリンクがある場合に、コレクションを強制的に削除するかどうかを選択します。コレクションを削除し、すべてのリンクをクリーンアップする場合は、forceDeleteパラメーターをtrueに設定します。選択しない場合、既定値はfalseです。このパラメーターは、誤った呼び出しを防止するために使用されます。
リクエストの例: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/collections/253fcf0b10204dc085f07bdf1b40e759?forceDelete=true' \ --header 'Authorization: Bearer BearerTokenGoesHere'
オブジェクト関係
コレクションを作成する場合、作成したオブジェクトを次のように使用することができます。
作成されたオブジェクト: " id " (例えば、"id": "7917969784f84bd09442f66996ecb8f3")
次のように使用できます。
特定のコレクションを検索する 場合、 collectionId として。
ユーザー 、 ユーザーグループ 、 ワークフロー 、 インサイト 、 スケジュール をコレクションに追加する場合、 collectionId として。
既存のコレクションを更新する 場合、 collectionId として。
特定のコレクションを削除する 場合、 collectionId として。
Postmanリクエストの例
POST /v3/collections
GET /v3/collections/
PUT /v3/collections/{collectionId}
Postmanリクエストの詳細については、「 Postmanの使用方法 」ヘルプページを参照してください。