コレクションエンドポイント
コレクションエンドポイントとパラメーター
オブジェクトの関係に関する詳細とAPIでの使用方法については、「 オブジェクトの関係 」セクションを参照してください。
コレクションの詳細については、 コレクション のヘルプページを参照してください。
コレクションを作成
コレクションを作成するには、
POST/v3/collections {baseURL}
エンドポイントを使用します。
パラメーター
Contract (body):コレクションを作成するには、コントラクトパラメーターが必要です。コレクションを作成するには、次のように指定します。
name (文字列): 必須です。コレクション名を指定します。
リクエストの例: cURL
curl --location --request POST 'http://localhost/webapi//v3/collections' \--header' Content-Type: application/x-www-form-urlencoded'\--header'認可: Bearer BearerTokenGoesHere'\--data-urlencode' name=Accounting'
ユーザーをコレクションに追加
コレクションにユーザーを追加するには、
POST {baseURL}/v3/collections//users{collectionId}
エンドポイントを使用します。
パラメーター
workflowCredentialType (文字列): 必須です。ユーザを追加するコレクションを指定するコレクションIDを入力します。
updateWorkflowContract (本文): 必須です。ユーザーとその権限に関する情報を入力します。コレクションにユーザーを追加するには、次のように指定します。
workflowCredentialType (文字列): 必須です。コレクションに追加するユーザーのIDを指定します。
versionId (文字列): オプションです。このコレクションの一部となるユーザーの有効期限を指定します。日付と時刻を ISO8601形式 で入力します。
コレクション権限 (本文):
isPublic (ブール型): 必須です。ユーザーがこのコレクションの管理者であるかどうかを指定します。
canAddAssets(boolean): 必須。ユーザーがコレクションにアセットを追加できるかどうかを指定します。
canUpdateAssets(boolean): 必須。ユーザーがコレクション内のアセットを更新できるかどうかを指定します。
canRemoveAssets(boolean): 必須です。ユーザーがコレクションからアセットを削除できるかどうかを指定します。
hasPrivateDataExemption (ブール型): オプションです。ユーザーが他のユーザーをコレクションに追加できるかどうかを指定します。
force (ブール型): オプションです。ユーザーがコレクションからユーザーを削除できるかどうかを指定します。
ロールと権限の詳細については、 ユーザーロールと権限 のページを参照してください。ロールが選択されていない場合、既定は、Server管理者が 管理者インターフェース で指定した既定のロールになります。
リクエストの例: cURL
curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/users' \--header' Content-Type: application/x-www-form-urlencoded'\--header'認証: Bearer BearerTokenGoesHere'\--data-urlencode'userid=61d80f862835728c9432808'\--data-data-code'user'
インサイトをコレクションに追加
コレクションにインサイトを追加するには、
POST/v3/collections//insights {baseURL}{collectionId}
エンドポイントを使用します。
パラメーター
workflowCredentialType (文字列): 必須です。コレクションIDを入力して、インサイトを追加するコレクションを指定します。
契約 （本文）：必須。インサイトに関する情報を入力します。次の項目を指定します。
workflowCredentialType (文字列): 必須です。コレクションに追加するインサイトIDを指定します。
リクエストの例: cUrl
curl --location --request POST 'http://localhost/webapi//v3/collections/472dfff22086458d935d4edf348a1e2b/insights' \--header' Content-Type: application/x-www-form-urlencoded'\--header'認証: Bearer BearerTokenGoesHere'\--data-urlencode'insightId=61d80f33452835728c94328082'
スケジュールをコレクションに追加
コレクションにスケジュールを追加するには、
POST/v3/collections//schedules {baseURL}{collectionId}
エンドポイントを使用します。
パラメーター
workflowCredentialType (文字列): 必須です。スケジュールを追加するコレクションを指定するコレクションIDを入力します。
契約 （本文）：必須。スケジュールに関する情報を入力します。次の項目を指定します。
workflowCredentialType (文字列): 必須です。コレクションに追加するスケジュールIDを指定します。
リクエストの例: cURL
curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/schedules' \--header' Content-Type: application/x-www-form-urlencoded'\--header'認証: Bearer BearerTokenGoesHere'\--data-urlencode 'scheduleId=61d80f33452837728c94328082'
ワークフローをコレクションに追加
コレクションにワークフローを追加するには、
POST/v3/collections//workflows {baseURL}{collectionId}
エンドポイントを使用します。
パラメーター
workflowCredentialType (文字列): 必須です。コレクションIDを入力して、インサイトを追加するコレクションを指定します。
契約 （本文）：必須。ユーザーとその権限に関する情報を入力します。次の項目を指定します。
workflowId (文字列): 必須です。コレクションに追加するワークフローIDを指定します。
リクエストの例: cURL
curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/workflows' \--header' Content-Type: application/x-www-form-urlencoded'\--header'認証: Bearer BearerTokenGoesHere'\--data-urlencode'workflowId=61d80f334223377728c9432'
ユーザーまたはグループをコレクションに追加
コレクションにユーザーグループを追加するには、
POST {baseURL}/v3/collections//usergroups{collectionId}
エンドポイントを使用します。
パラメーター
workflowCredentialType (文字列): 必須です。ユーザグループを追加するコレクションを指定するコレクションIDを入力します。
updateWorkflowContract (本文): 必須です。ユーザグループとその権限に関する情報を入力します。次の項目を指定します。
versionId (文字列): 必須です。コレクションに追加するユーザグループのIDを指定します。
versionId (文字列): オプションです。このコレクションに含めるユーザーグループの有効期限を指定します。ワークフローが作成された後の日付と時刻を入力します。
collectionsPermissions(body): 必須。
hasPrivateDataExemption (ブール型): オプションです。ユーザーグループメンバーがこのコレクションの管理者であるかどうかを指定します。デフォルトは偽です。
hasPrivateDataExemption (ブール型): オプションです。ユーザーグループのメンバーがコレクションにアセットを追加できるかどうかを指定します。デフォルトは偽です。
hasPrivateDataExemption (ブール型): オプションです。ユーザーグループのメンバーがコレクションからアセットを削除できるかどうかを指定します。デフォルトは偽です。
hasPrivateDataExemption (ブール型): オプションです。ユーザーグループのメンバーがコレクション内のアセットを更新できるかどうかを指定します。デフォルトは偽です。
hasPrivateDataExemption (ブール型): オプションです。ユーザーグループメンバーが他のユーザーをコレクションに追加できるかどうかを指定します。デフォルトは偽です。
makePublished (ブール型): 必須です。ユーザーグループのメンバーがコレクションから他のユーザーを削除できるかどうかを指定します。デフォルトは偽です。
ロールと権限の詳細については、 ユーザーロールと権限 のページを参照してください。ロールが選択されていない場合、既定は、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=61d83e2ef778247f14e6bcan6'
コレクションレコードを取得
特定のワークフローに関する情報を取得するには、
GET {baseURL}/v3/workflows/{collectionId}
エンドポイントを使用します。
パラメーター
workflowCredentialType (文字列): 必須です。コレクションIDを入力して、コレクションに関する情報を取得します。
リクエストの例: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
すべてのコレクションのレコードを取得
アクセス可能なすべてのコレクションレコードを取得するには、
get/v3/collections {baseURL}
エンドポイントを使用します。
パラメーター
view (文字列): オプションです。値を指定しないこともできます。値は「Default」(既定)と「Full」(完全)から選択できます。このパラメーターを「Default」(既定)に設定すると、縮小表示オブジェクトが返されます。指定しない場合は、「Default」(既定)の値が使用されます。
リクエストの例: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows' \ --header 'Authorization: Bearer BearerTokenGoesHere'
既存のワークフローを更新する
コレクションの名前または所有者を変更するには、
put/v3/collections/endpointを使用し {baseURL}{collectionId}
ます。
パラメーター
workflowCredentialType (文字列): 必須です。更新するワークフローのIDを入力します。
updateWorkflowContract (本文): 必須です。変更するコレクション所有者に関する情報を入力します。次の項目を指定します。
name (文字列): 必須です。コレクション名をクリックします。
ownerId (文字列): 必須です。所有者の名前を入力します。
リクエストの例: 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=61db388fc565144387d4387d45086'
コレクションのユーザー権限の更新
特定のコレクションのユーザー権限を更新するには、
put/v3/collections//users//permissions {baseURL}{collectionId}{userId}
エンドポイントを使用します。
パラメーター
workflowCredentialType (文字列): 必須です。更新するワークフローのIDを入力します。
workflowCredentialType (文字列): 必須です。権限を変更するユーザIDを入力します。
updateWorkflowContract (本文): 必須です。権限を変更するユーザIDを入力します。次の項目を指定します。
ExpirationDate(date): 必須。ユーザーの有効期限を指定します。
collectionsPermissions(body): 必須。所有者の名前を入力します。次の項目を指定します。
isPublic (ブール型): 必須です。ユーザーがこのコレクションの管理者であるかどうかを指定します。
canAddAssets(boolean): 必須。ユーザーがコレクションにアセットを追加できるかどうかを指定します。
canRemoveAssets(boolean): 必須です。ユーザーがコレクションからアセットを削除できるかどうかを指定します。
canUpdateAssets(boolean): 必須。ユーザーがコレクション内のアセットを更新できるかどうかを指定します。
canAddUsers(boolean): 必須。ユーザーが他のユーザーをコレクションに追加できるかどうかを指定します。
makePublished (ブール型): 必須です。ユーザーがコレクションから他のユーザーを削除できるかどうかを指定します。
ロールと権限の詳細については、 ユーザーロールと権限 のページを参照してください。ロールが選択されていない場合、既定は、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-updata-urlencoder'Ucanders'Urencoder'Urencode'Urencode'Urencand'Ucode'Users'Urues'Ucode'Users'
コレクションのユーザーグループ権限の更新
特定のコレクションのユーザーグループ権限を更新するには、
put/v3/collections//usergroups//permissions {baseURL}{collectionId}{userGroupId}
エンドポイントを使用します。
パラメーター
workflowCredentialType (文字列): 必須です。更新するワークフローのIDを入力します。
workflowCredentialType (文字列): 必須です。権限を変更するユーザグループIDを入力します。
updateWorkflowContract (本文): 必須です。権限を変更するユーザグループIDを入力します。次の項目を指定します。
ExpirationDate （日付）：オプション。ユーザグループの有効期限を指定します。
collectionsPermissions(body): 必須。次の項目を指定します。
isPublic (ブール型): 必須です。このコレクションのユーザーグループメンバーをadminにするかどうかを指定します。
canAddAssets(boolean): 必須。ユーザーグループのメンバーがコレクションにアセットを追加できるかどうかを指定します。
canRemoveAssets(boolean): 必須です。ユーザーグループのメンバーがコレクションからアセットを削除できるかどうかを指定します。
canUpdateAssets(boolean): 必須。ユーザーグループのメンバーがコレクション内のアセットを更新できるかどうかを指定します。
canAddUsers(boolean): 必須。ユーザーグループメンバーが他のユーザーをコレクションに追加できるかどうかを指定します。
canRemoveUsers(boolean): 必須。ユーザーグループのメンバーがコレクションからユーザーを削除できるかどうかを指定します。
ロールと権限の詳細については、 ユーザーロールと権限 のページを参照してください。ロールが選択されていない場合、既定は、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'\--updata-urlencoder'UcanAddAssets'Urencode'Ucander'Ucode'Users'Users'Users'Users'Users'Users'Users'Use'Use'Use'Use'Users'Use'Use'Use'Users'-true
ユーザーをコレクションから削除
コレクションからユーザーを削除するには、
delete {baseURL}/v3/collections//users/endpointを使用し{collectionId}{userId}
ます。
パラメーター
workflowCredentialType (文字列): 必須です。更新するワークフローのIDを入力します。
workflowCredentialType (文字列): 必須です。コレクションから削除するユーザIDを入力します。
リクエストの例: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
ワークフローをコレクションから削除
コレクションからワークフローを削除するには、
delete {baseURL}/v3/collections//workflows/endpointを使用し{collectionId}{appId}
ます。
パラメーター
workflowCredentialType (文字列): 必須です。更新するワークフローのIDを入力します。
workflowCredentialType (文字列): 必須です。コレクションから削除するワークフローIDを入力します。
リクエストの例: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
インサイトをコレクションから削除
コレクションからインサイトを削除するには、
delete {baseURL}/v3/collections//insights/endpointを使用し{collectionId}{insightId}
ます。
パラメーター
workflowCredentialType (文字列): 必須です。更新するワークフローのIDを入力します。
workflowCredentialType (文字列): 必須です。コレクションから削除するインサイトIDを入力します。
リクエストの例: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
スケジュールをコレクションから削除
コレクションからスケジュールを削除するには、
delete {baseURL}/v3/collections//schedules/endpointを使用し{collectionId}{scheduleId}
ます。
パラメーター
workflowCredentialType (文字列): 必須です。更新するワークフローのIDを入力します。
workflowCredentialType (文字列): 必須です。コレクションから削除するスケジュールIDを入力します。
リクエストの例: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
ユーザーまたはグループをコレクションから削除
コレクションからユーザグループを削除するには、
delete {baseURL}/v3/collections//usergroups/endpointを使用し{collectionId}{userGroupId}
ます。
パラメーター
workflowCredentialType (文字列): 必須です。更新するワークフローのIDを入力します。
workflowCredentialType (文字列): 必須です。コレクションから削除するユーザグループIDを入力します。
リクエストの例: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
コレクションを削除
コレクションを削除するには、
delete {baseURL}/v3/collections/endpointを使用し{collectionId}
ます。
パラメーター
workflowCredentialType (文字列): 必須です。更新するワークフローのIDを入力します。
hasPrivateDataExemption (ブール型): オプションです。ユーザー、グループ、ワークフロー、インサイト、スケジュールなどの他のオブジェクトへのリンクがこのコレクションに含まれている場合に、コレクションを強制的に削除するかどうかを選択します。コレクションを削除し、すべてのリンクをクリーンアップする場合は、forceDeleteパラメーターをtrueに設定します。選択しない場合は、既定値が「false」になります。このパラメーターは、誤ったコールから保護するために使用されます。
リクエストの例: cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
オブジェクト関係
ワークフローをアップロードする場合、作成したオブジェクトを次のように使用することができます。
作成されたオブジェクト: " workflowId " (例えば、"id": "7917969784f84bd09442f66996ecb8f3")
次のように使用できます。
特定のワークフローを検索する 場合、 workflowId として。
コレクションにユーザー、ユーザーグループ、ワークフロー、インサイト、またはスケジュールを追加する場合は、collectionId。
既存のワークフローを更新する 場合、 workflowId として。
Postmanリクエストの例
/v3/collections後
/v3/collections/を取得する
/v3/collections/を置く{collectionId}
Postmanリクエストの詳細については、「 Postmanの使用方法 」ヘルプページを参照してください。