リポジトリ割当て済タイプのリスト
get
/content/management/api/v1.1/repositories/{id}/assignedTypes
リポジトリで割り当てられたタイプをリストします。
リクエスト
パス・パラメータ
- id: string
割り当てられたタイプのリポジトリIDパラメータ。
問合せパラメータ
- fields(optional): string
このパラメータは、リストの各タイプで返されるフィールドを制御するために使用します。 このパラメータは、フィールド名のカンマ区切りリストを受け入れます。 すべてのフィールド名は、大/小文字が区別されます。 各割当タイプには、次のフィールドを設定できます: id, name, displayName, apiName, description, typeCategory, createdBy, createdDate, updatedBy, updatedDate, allowedActions, allowedFileTypes, fields, properties, layoutMapping, inplacePreview. このパラメータはオプションです。 存在しない場合、これらのデフォルト・フィールドはレスポンスで返されます: id, name, description。 問合せで指定された不正または無効なフィールド名は無視されます。
例:
?fields=id,name,displayName,typeCategory,allowedActions
これにより、割り当てられたタイプごとにid、name、displayName、typeCategoryおよび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、displayNameおよびupdatedDateのみです。デフォルト値:
name:asc - q(optional): string
このパラメータは、フィールド値に一致する問合せ式条件を受け入れます。 問合せ条件の値は、{fieldName} {operator} "{fieldValue}"の形式に従います。 現在許可されているfieldNamesは、allowedActions、allowedFileTypes、typeCategory、nameおよびdisplayNameのみです。 許可される演算子は、allowedActions、allowedFileTypesおよびtypeCategoryのeq、およびnameおよびdisplayNameのcoのみです。 許可される論理演算子はANDのみです。 この問合せパラメータはオプションです。
例:
?q=(allowedActions eq "ASSET_CREATE")
これにより、ユーザーがリポジトリにアセットを作成できるタイプが返されます。
例:
?q=(displayName co "asset")
これは、リポジトリに割り当てられた文字列"asset" (大/小文字を区別しない)を含む表示名を持つタイプを返します。
例:
?q=(typeCategory eq "ContentType")
これにより、リポジトリに割り当てられたContentTypeタイプが返されます。
例:
?q=(typeCategory eq "DigitalAssetType" AND allowedFileTypes eq "jpg")
これにより、"jpg"ファイル拡張子をサポートするリポジトリに割り当てられたDigitalAssetType型が返されます。 - totalResults(optional): boolean
このパラメータは、ブール・フラグを受け入れます。 trueとして指定した場合、返される結果には合計結果数が含まれる必要があります。デフォルト値:
false
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
OK。
ルート・スキーマ : AssignedTypes
型:
objectAssignedTypes
ソースを表示
- 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)
クライアント・リクエストを満たすローの総数(ページング・パラメータを除く)
ネストされたスキーマ : AssignedType
型:
objectAssignedType
ソースを表示
- allowedActions(optional): array allowedActions
ログイン・ユーザーは、割り当てられたタイプのアセットに対するアクションを許可しました。 アクションは、"ASSET_VIEW"、"ASSET_UPDATE"、"ASSET_CREATE"および"ASSET_DELETE"です。
- allowedFileTypes(optional): array allowedFileTypes
割り当てられたタイプのサポートされているファイル拡張子のリスト。
- apiName(optional): string
割り当てられたタイプのAPI名。
- createdBy(optional): string
割り当てられたタイプの作成者ユーザー。
- createdDate(optional): object date
date
- description(optional): string
割り当てられたタイプの摘要。
- displayName(optional): string
割り当てられたタイプの表示名。
- fields(optional): array fields
割り当てられたタイプのフィールドのリスト。
- id(optional): string
割り当てられたタイプのID。
- inplacePreview(optional): array inplacePreview
割り当てられたタイプのインプレース・プレビューのリスト。
- layoutMapping(optional): array layoutMapping
割り当てられたタイプのレイアウト・マッピングのリスト。
- links(optional): array links
割り当てられたタイプのリソースのリンク。
- name(optional): string
割り当てられたタイプの名前。
- properties(optional): object properties
許可される追加のプロパティ: additionalProperties割り当てられたタイプのプロパティ。
- typeCategory(optional): string
割当済タイプのカテゴリ。 カテゴリは、"ContentType"または"DigitalAssetType"です。
- updatedBy(optional): string
割り当てられたタイプのユーザーによる更新。
- updatedDate(optional): object date
date
ネストされたスキーマ : allowedActions
型:
arrayログイン・ユーザーは、割り当てられたタイプのアセットに対するアクションを許可しました。 アクションは、"ASSET_VIEW"、"ASSET_UPDATE"、"ASSET_CREATE"および"ASSET_DELETE"です。
ソースを表示
ネストされたスキーマ: fields
型:
array割り当てられたタイプのフィールドのリスト。
ソースを表示
- Array of: object TypeField
FieldInAggrType.
ネストされたスキーマ : inplacePreview
型:
array割り当てられたタイプのインプレース・プレビューのリスト。
ソースを表示
- Array of: object InplacePreview
InplacePreview
ネストされたスキーマ : layoutMapping
型:
array割り当てられたタイプのレイアウト・マッピングのリスト。
ソースを表示
- Array of: object LayoutMapping
LayoutMapping
ネストされたスキーマ : TypeField
型:
objectFieldInAggrType.
ソースを表示
- apiName(optional): string
フィールドのAPI名。
- archivedBy(optional): string
アーカイブしました。
- archivedDate(optional): object date
date
- datatype(optional): string
許容値:
[ "number", "long", "decimal", "text", "largetext", "reference", "datetime", "boolean" ]データ型列挙。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。 - defaultValue(optional): object defaultValue
フィールドのdefaultValue。
- description(optional): string
フィールドの説明。
- id(optional): string
フィールドのid。 これはレスポンス取得と送信リクエストの必須プロパティであり、リクエストの転送には必要ありません。
- isSystemField(optional): boolean
システムによって提供されるフィールドです。
- name(optional): string
フィールドの名前。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。
- properties(optional): object properties
許可される追加のプロパティ: additionalPropertiesフィールド固有のプロパティ。 publishingDependencyフィールドは、メディアおよび参照に固有です。
- required(optional): boolean
フィールドの必須またはオプションの値。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。
- settings(optional): object settings
許可される追加のプロパティ: additionalPropertiesフィールド固有の設定。
- valuecount(optional): string
許容値:
[ "single", "list" ]値は単一またはリストとしてカウントされます。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。
ネストされたスキーマ : defaultValue
型:
objectフィールドのdefaultValue。
ネストされたスキーマ: properties
型:
object使用可能なその他のプロパティ
ソースを表示
フィールド固有のプロパティ。 publishingDependencyフィールドは、メディアおよび参照に固有です。
例:
{caas-translation: {inheritFromMaster: false}, publishingDependency: optional}ネストされたスキーマ: additionalProperties
型:
objectネストされたスキーマ: additionalProperties
型:
objectネストされたスキーマ : LayoutMapping
型:
objectLayoutMapping
ソースを表示
- apiName(optional): string
レイアウトの名前。
- formats(optional): object formats
許可される追加のプロパティ: additionalPropertiesレイアウト形式。
- generateRendition(optional): boolean
generateRendition.
- id(optional): integer(int64)
レイアウト・マッピングのID。
- label(optional): string
レイアウト・マッピングのカテゴリの名前です。
ネストされたスキーマ: Link
型:
objectリソースのリンク。
ソースを表示
- href(optional): string
ターゲット・リソースのURI それはテンプレートURIである可能性があります。 これはレスポンス取得の必須プロパティです。
- mediaType(optional): string
メディア・タイプ。
- method(optional): string
ターゲット・リソースへのアクセスに使用できるHTTPメソッド。
- profile(optional): string
ターゲット・リソースを記述するメタデータにリンクします。
- rel(optional): string
関連タイプ これはレスポンス取得の必須プロパティです。
- templated(optional): boolean
URIがテンプレートであるかどうか。
ネストされたスキーマ: additionalProperties
型:
object304 レスポンス
変更されていません。
400レスポンス
不正リクエスト
403レスポンス
禁止。
404レスポンス
見つかりません。
500レスポンス
内部サーバー・エラー
例
次の例は、cURLを使用してGETリクエストを発行することによって、リポジトリに割り当てられたタイプをリストする方法を示しています。
curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/repositories/{id}/assignedTypes'
例1
/content/management/api/v1.1/repositories/DE7E10DE3F7940A38C6584E4887ED281/assignedTypes?q=allowedActions eq \"ASSET_CREATE\"&totalResults=true&offset=0&limit=10&orderBy=displayName:asc&fields=id,name,displayName,apiName,description,typeCategory,createdBy,createdDate,updatedBy,updatedDate,allowedActions
これにより、リポジトリDE7E10DE3F7940A38C6584E4887ED281に割り当てられ、ユーザーがこれらのタイプのアセットに対する作成権限を持ち、タイプ表示名の昇順でソートされます。
レスポンス本文
{
"hasMore": false,
"offset": 0,
"count": 3,
"limit": 10,
"totalResults": 3,
"items": [
{
"id": "C986A82C2F1A4C5DA1F0379343B62620",
"name": "File",
"displayName": "File",
"apiName": "file",
"description": "Asset type for assets other than images and videos",
"typeCategory": "DigitalAssetType",
"createdBy": "system",
"createdDate": {
"value": "2017-01-01T00:00:00.000Z",
"timezone": "UTC"
},
"updatedBy": "system",
"updatedDate": {
"value": "2017-01-01T00:00:00.000Z",
"timezone": "UTC"
},
"allowedActions": [
"ASSET_VIEW",
"ASSET_UPDATE",
"ASSET_CREATE",
"ASSET_DELETE"
],
"links": [
{
"href": "http://{hostname}/content/management/api/v1.1/types/File",
"rel": "canonical",
"method": "GET",
"mediaType": "application/json"
}
]
},
{
"id": "EF4C64E6BF81419F9743A8A4348A69EB",
"name": "Image",
"displayName": "Image",
"apiName": "image",
"description": "Asset type for images",
"typeCategory": "DigitalAssetType",
"createdBy": "system",
"createdDate": {
"value": "2017-01-01T00:00:00.000Z",
"timezone": "UTC"
},
"updatedBy": "system",
"updatedDate": {
"value": "2017-01-01T00:00:00.000Z",
"timezone": "UTC"
},
"allowedActions": [
"ASSET_VIEW",
"ASSET_UPDATE",
"ASSET_CREATE",
"ASSET_DELETE"
],
"links": [
{
"href": "http://{hostname}/content/management/api/v1.1/types/Image",
"rel": "self",
"method": "canonical",
"mediaType": "application/json"
}
]
},
{
"id": "FCC73EFCAD8B4BFDA3FD73D5DCBC8099",
"name": "TypeAAA",
"displayName": "TypeAAA",
"apiName": "typeAaa",
"description": "",
"typeCategory": "ContentType",
"createdBy": "cecuser1",
"createdDate": {
"value": "2022-12-16T20:16:38.336Z",
"timezone": "UTC"
},
"updatedBy": "cecuser1",
"updatedDate": {
"value": "2022-12-16T20:17:13.135Z",
"timezone": "UTC"
},
"allowedActions": [
"ASSET_VIEW",
"ASSET_UPDATE",
"ASSET_CREATE"
],
"links": [
{
"href": "http://{hostname}/content/management/api/v1.1/types/TypeAAA",
"rel": "canonical",
"method": "GET",
"mediaType": "application/json"
}
]
}
],
"links": [
{
"href": "http://{hostname}/content/management/api/v1.1/repositories/DE7E10DE3F7940A38C6584E4887ED281/assignedTypes?q=allowedActions eq \"ASSET_CREATE\"&totalResults=true&offset=0&limit=10&orderBy=displayName:asc&fields=id,name,displayName,apiName,description,typeCategory,createdBy,createdDate,updatedBy,updatedDate,allowedActions",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "http://{hostname}/content/management/api/v1.1/repositories/DE7E10DE3F7940A38C6584E4887ED281/assignedTypes?q=allowedActions eq \"ASSET_CREATE\"&totalResults=true&offset=0&limit=10&orderBy=displayName:asc&fields=id,name,displayName,apiName,description,typeCategory,createdBy,createdDate,updatedBy,updatedDate,allowedActions",
"rel": "canonical",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "http://{hostname}/content/management/api/v1.1/metadata-catalog/repositories/DE7E10DE3F7940A38C6584E4887ED281/assignedTypes",
"rel": "describedby",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "http://{hostname}/content/management/api/v1.1/repositories/DE7E10DE3F7940A38C6584E4887ED281/assignedTypes?q=allowedActions eq \"ASSET_CREATE\"&totalResults=true&offset=0&limit=10&orderBy=displayName:asc&fields=id,name,displayName,apiName,description,typeCategory,createdBy,createdDate,updatedBy,updatedDate,allowedActions",
"rel": "first",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "http://{hostname}/content/management/api/v1.1/repositories/DE7E10DE3F7940A38C6584E4887ED281/assignedTypes?q=allowedActions eq \"ASSET_CREATE\"&totalResults=true&offset=0&limit=10&orderBy=displayName:asc&fields=id,name,displayName,apiName,description,typeCategory,createdBy,createdDate,updatedBy,updatedDate,allowedActions",
"rel": "last",
"method": "GET",
"mediaType": "application/json"
}
]
}