リポジトリ割当てタクソノミのリスト
get
/content/management/api/v1.1/repositories/{id}/assignedTaxonomies
リポジトリで割り当てられたタクソノミをリストします。
リクエスト
パス・パラメータ
- id: string
リポジトリのId。
問合せパラメータ
- fields(optional): string
このパラメータは、リスト内の割り当てられた各タクソノミで返されるフィールドを制御するために使用されます。 このパラメータは、フィールド名のカンマ区切りリストを受け入れます。 これらのフィールドは、リスト内の割り当てられたタクソノミに対して返されます。 すべてのフィールド名は大/小文字が区別され、ユーザーは問合せで正しいフィールド名を指定する必要があります。 割り当てられた各タクソノミには、これらのフィールドを含めることができます: id, name, description, shortName, version, isPublishable, isForSiteManagement, createdBy, createdDate, updatedBy, updatedDate, allowedActions. このパラメータはオプションです。 存在しない場合、レスポンスにデフォルトのフィールドが返されます: id, name, description。 パラメータに正しくない、または無効なフィールド名を指定すると、エラーがスローされます。
例: ?fields=id,name,shortName,isForSiteManagement,allowedActions
これにより、割り当てられた各タクソノミのid、name、shortName、isForSiteManagementおよびallowedActionsフィールドが戻されます。
- limit(optional): integer(int32)
このパラメータは、負でない整数を受け入れ、結果のサイズの制御に使用します。デフォルト値:
25 - links(optional): string
このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby, first, 最後, prev, next
- offset(optional): integer(int32)
このパラメータは、負でない整数を受け入れ、結果の開始インデックスを制御するために使用します。デフォルト値:
0 - orderBy(optional): string
このパラメータは、結果の順序を制御するために使用します。 この問合せパラメータの値は、fieldName:[asc/desc]の書式に従います。「昇順」は昇順、「説明」は降順、デフォルトの順序は「昇順」です。フィールド名で使用できるフィールドは、nameおよびupdatedDateのみです。 このパラメータのデフォルト値は「名前:asc」です。デフォルト値:
name:asc - q(optional): string
このパラメータは、フィールド値に一致する問合せ式条件を受け入れます。 問合せ条件は、AND演算子を使用して結合し、カッコでグループ化できます。 問合せ条件の値は、{fieldName} {operator} "{fieldValue}"の形式に従います。 許可されるフィールド名は、name、isForSiteManagementおよびallowedActionsのみです。 問合せに同じ名前付きフィールドを複数含めることはできません。
許可される演算子はisForSiteManagementのeq (Equals)のみで、許可される値は"false"または"true"です。
許可される演算子はnameのco (Contains)のみであり、その値では大/小文字が区別されません。
許可される演算子はallowedActionsのeq (等号)のみで、許可される値は"ASSET_CATEGORIZE"または"SITE_CREATE"です。
例:
?q=(isForSiteManagement eq "true") AND (allowedActions eq "SITE_CREATE")
この問合せでは、isForSiteManagementとallowedActionsの両方のフィールドで割り当てられたタクソノミをフィルタして、ユーザーがサイトの作成権限を持っているサイト・セキュリティ・タクソノミを返します。
例:
?q=(allowedActions eq "ASSET_CATEGORIZE") AND (name co "org")
この問合せでは、allowedActionsフィールドとnameフィールドの両方によって割り当てられたタクソノミをフィルタ処理して、「org」(大文字と小文字を区別しない)名前を持つタクソノミを返し、ユーザーにカテゴリ化権限があります。 - totalResults(optional): boolean
このパラメータは、ブール・フラグを受け入れます。 trueとして指定した場合、返される結果には合計結果数が含まれる必要があります。デフォルト値:
false
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
OK。
ルート・スキーマ : AssignedTaxonomies
型:
objectAssignedTaxonomies
ソースを表示
- aggregationResults(optional): array aggregationResults
集計結果。
- count(optional): integer(int32)
現在のレスポンス内のレコードの合計数
- hasMore(optional): boolean
フェッチするページがまだあるかどうかを確認します。
- items(optional): array items
コレクションに含まれる特異なリソース。
- limit(optional): integer(int32)
サーバーによって使用される実際のページ・サイズ。 これは、クライアントがリクエストするものと同じではない可能性があります。
- links(optional): array links
リソースのリンク。
- offset(optional): integer(int32)
特異リソースが返される実際のインデックス。
- pinned(optional): array pinned
固定品目。 検索リストの上部に固定されたアイテムを表示
- scrollId(optional): string
scrollId:検索がスクロール検索に解決された場合。
- totalResults(optional): integer(int32)
クライアント・リクエストを満たすローの総数(ページング・パラメータを除く)
ネストされたスキーマ: items
型:
arrayコレクションに含まれる特異なリソース。
ソースを表示
- Array of: object AssignedTaxonomy
AssignedTaxonomy
ネストされたスキーマ : AssignedTaxonomy
型:
objectAssignedTaxonomy
ソースを表示
- allowedActions(optional): array allowedActions
割り当てられたタクソノミで許可されるアクション。 アクションは、"ASSET_CATEGORIZE"および"SITE_CREATE"です。
- createdBy(optional): string
割り当てられたタクソノミのユーザーによって作成されます。
- createdDate(optional): object date
date
- description(optional): string
割り当てられたタクソノミの説明。
- id(optional): string
割り当てられたタクソノミのID。
- isForSiteManagement(optional): boolean
割り当てられたタクソノミがサイト管理用かどうか。
- isPublishable(optional): boolean
割り当てられたタクソノミが公開可能かどうか。
- links(optional): array links
割り当てられたタクソノミ・リソースのリンク。
- name(optional): string
割り当てられたタクソノミの名前。
- shortName(optional): string
割り当てられたタクソノミの短縮名。
- updatedBy(optional): string
割り当てられたタクソノミのユーザーが更新しました。
- updatedDate(optional): object date
date
- version(optional): integer(int32)
割り当てられたタクソノミのバージョン。
ネストされたスキーマ : allowedActions
型:
array割り当てられたタクソノミで許可されるアクション。 アクションは、"ASSET_CATEGORIZE"および"SITE_CREATE"です。
ソースを表示
ネストされたスキーマ: Link
型:
objectリソースのリンク。
ソースを表示
- href(optional): string
ターゲット・リソースのURI それはテンプレートURIである可能性があります。 これはレスポンス取得の必須プロパティです。
- mediaType(optional): string
メディア・タイプ。
- method(optional): string
ターゲット・リソースへのアクセスに使用できるHTTPメソッド。
- profile(optional): string
ターゲット・リソースを記述するメタデータにリンクします。
- rel(optional): string
関連タイプ これはレスポンス取得の必須プロパティです。
- templated(optional): boolean
URIがテンプレートであるかどうか。
304 レスポンス
変更されていません。
400レスポンス
不正リクエスト
403レスポンス
禁止。
404レスポンス
見つかりません。
500レスポンス
内部サーバー・エラー
例
次の例は、cURLを使用してGETリクエストを発行することによって、リポジトリに割り当てられたタクソノミをリストする方法を示しています。
curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/repositories/{id}/assignedTaxonomies'
例:
ここには、リポジトリ720E2B7391E64FB9A1EB5FA6DEA8F4C7に割り当てられているタクソノミがリストされます。isForSiteManagementフィールドは"true"に設定され、名前フィールドには"org"大文字と小文字が区別されず、タクソノミ名昇順にソートされます。
/content/management/api/v1.1/repositories/720E2B7391E64FB9A1EB5FA6DEA8F4C7/assignedTaxonomies?offset=0&limit=10&orderBy=name:asc&q=(isForSiteManagement eq \"true\") AND (name co \"org\")&fields=id,name,description,shortName,version,isPublishable,isForSiteManagement,allowedActions&totalResults=true
レスポンス本文
{
"hasMore": false,
"offset": 0,
"count": 2,
"limit": 2,
"totalResults": 2,
"items": [
{
"id": "FB8240D6DC70407F87ED111325D06F89",
"name": "Organization1",
"description": "organization one",
"shortName": "ORG",
"version": 1,
"isPublishable": false,
"isForSiteManagement": true,
"allowedActions": [
"ASSET_CATEGORIZE",
"SITE_CREATE"
],
"links": [
{
"href": "http://{hostname}/content/management/api/v1.1/taxonomies/FB8240D6DC70407F87ED111325D06F89",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
{
"id": "9252676B0FD34FFCB40C6F65030001E7",
"name": "Organization2",
"description": "organization two",
"shortName": "OR1",
"version": 1,
"isPublishable": false,
"isForSiteManagement": true,
"allowedActions": [],
"links": [
{
"href": "http://{hostname}/content/management/api/v1.1/taxonomies/9252676B0FD34FFCB40C6F65030001E7",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
}
],
"links": [
{
"href": "http://{hostname}/content/management/api/v1.1/repositories/720E2B7391E64FB9A1EB5FA6DEA8F4C7/assignedTaxonomies?q=(isForSiteManagement eq \"true\") AND (name co \"org\")&totalResults=true&offset=0&limit=10&orderBy=name:asc&fields=id,name,description,shortName,version,isPublishable,isForSiteManagement,allowedActions",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "http://{hostname}/content/management/api/v1.1/repositories/720E2B7391E64FB9A1EB5FA6DEA8F4C7/assignedTaxonomies?q=(isForSiteManagement eq \"true\") AND (name co \"org\")&totalResults=true&offset=0&limit=10&orderBy=name:asc&fields=id,name,description,shortName,version,isPublishable,isForSiteManagement,allowedActions",
"rel": "canonical",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "http://{hostname}/content/management/api/v1.1/metadata-catalog/repositories/720E2B7391E64FB9A1EB5FA6DEA8F4C7/assignedTaxonomies",
"rel": "describedby",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "http://{hostname}/content/management/api/v1.1/repositories/720E2B7391E64FB9A1EB5FA6DEA8F4C7/assignedTaxonomies?q=(isForSiteManagement eq \"true\") AND (name co \"org\")&totalResults=true&offset=0&limit=10&orderBy=name:asc&fields=id,name,description,shortName,version,isPublishable,isForSiteManagement,allowedActions",
"rel": "first",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "http://{hostname}/content/management/api/v1.1/repositories/720E2B7391E64FB9A1EB5FA6DEA8F4C7/assignedTaxonomies?q=(isForSiteManagement eq \"true\") AND (name co \"org\")&totalResults=true&offset=0&limit=10&orderBy=name:asc&fields=id,name,description,shortName,version,isPublishable,isForSiteManagement,allowedActions",
"rel": "last",
"method": "GET",
"mediaType": "application/json"
}
]
}