リポジトリの作成
/content/management/api/v1.1/repositories
リクエスト
- application/json
- links(optional): string
このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby
- X-Requested-With: string
CSRF攻撃を軽減するためのカスタム・ヘッダー。許容値:
[ "XMLHttpRequest" ]
object- advancedVideoEnabled(optional): boolean
リポジトリで拡張ビデオが使用可能かどうか。
- autoTagEnabled(optional): boolean
リポジトリに対して自動タグ付けを有効にするかどうか。
- channels(optional): array channels
リポジトリに関連付けられているチャネル。
- configuredLanguages(optional): array configuredLanguages
リポジトリの構成済言語。
- connectors(optional): array connectors
リポジトリに関連付けられたコネクタ。
- contentTypes(optional): array contentTypes
リポジトリに関連付けられているタイプ。
- createdBy(optional): string
リポジトリのcreatedByユーザー。
- createdDate(optional): object date
date
- customDigitalAssetsEnabled(optional): boolean
カスタム・デジタル・アセットがリポジトリに対して有効かどうか。
- defaultLanguage(optional): string
リポジトリのデフォルト言語。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。
- description(optional): string
リポジトリの説明。
- editorialRoles(optional): array editorialRoles
リポジトリに関連付けられた編集ロール。
- id(optional): string
リポジトリのId。 これはレスポンス取得と送信リクエストの必須プロパティであり、リクエストの転送には必要ありません。
- languageOptions(optional): array languageOptions
リポジトリの言語オプション。
- links(optional): array links
リンク
- name(optional): string
リポジトリの名前。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。
- notReadyEnabled(optional): boolean
リポジトリに対して準備ができていないアセットが有効になっているかどうか。
- repositoryType(optional): string
許容値:
[ "Standard", "Business" ]リポジトリのタイプ。 標準、ビジネスの値を指定できます。 デフォルト値は標準です。 - roleName(optional): string
リポジトリのユーザー・ロールの名前。
- taxonomies(optional): array taxonomies
リポジトリに関連付けられているタクソノミ。
- typeWorkflows(optional): object TypeWorkflowsBean
TypeWorkflowsBean
- updatedBy(optional): string
リポジトリのupdatedByユーザー。
- updatedDate(optional): object date
date
- viewAllCollectionsEnabled(optional): boolean
すべてのコレクションの表示がリポジトリに対して有効になっているかどうか。
- workflows(optional): array workflows
リポジトリに関連付けられたワークフロー。
array- Array of: object ChannelBeanInRepository
ChannelBeanInRepository
array- Array of: object EditorialRoleId
EditorialRoleId
object- allTypes(optional): object WorkflowsOnAllAssetTypes
すべてのアセット・タイプのワークフロー。
- types(optional): array types
特定のアセット・タイプ。
object- defaultLanguage(optional): string
デフォルト言語。
- id(optional): string
- isPrimaryChannel(optional): boolean
チャネルがアセットのプライマリかどうかを示します。
- isSiteChannel(optional): boolean
チャネルがサイト・チャネルであるかどうかをチェックします。
- isSitePlanChannel(optional): boolean
- links(optional): array links
リンク
- localizationPolicy(optional): string
チャネルのローカリゼーション・ポリシー。
- name(optional): string
- optionalLanguages(optional): array optionalLanguages
オプションの言語。
- primaryChannelSupported(optional): boolean
プライマリ・チャネルがサポートされています。
- requiredLanguages(optional): array requiredLanguages
必須言語。
object- href(optional): string
ターゲット・リソースのURI それはテンプレートURIである可能性があります。 これはレスポンス取得の必須プロパティです。
- mediaType(optional): string
メディア・タイプ。
- method(optional): string
ターゲット・リソースへのアクセスに使用できるHTTPメソッド。
- profile(optional): string
ターゲット・リソースを記述するメタデータにリンクします。
- rel(optional): string
関連タイプ これはレスポンス取得の必須プロパティです。
- templated(optional): boolean
URIがテンプレートであるかどうか。
object- connectorId(optional): string
コネクタのId。 これはレスポンス取得の必須プロパティです。
- connectorName(optional): string
コネクタの名前 これはレスポンス取得の必須プロパティです。
- connectorType(optional): string
コネクタのタイプ。 これはレスポンス取得の必須プロパティです。
- isDigitalContentConnector(optional): boolean
読取り専用:
trueデジタル・アセット・コネクタの場合はTrue、それ以外の場合はfalse - supportedContentTypes(optional): array supportedContentTypes
コネクタのサポートされているコンテンツ・タイプ。
object- name(optional): string
- typeCategory(optional): string
アセット・タイプのtypeCategory。
object- description(optional): string
カスタム編集ロールの説明。
- id: string
カスタム編集ロールのID。
- name(optional): string
カスタム編集ロールの名前。
object- default(optional): array default
手動起動
- required(optional): boolean
必須かどうか。
- startOnCreate(optional): array startOnCreate
作成時に自動開始。
array- Array of: object WorkflowsOnSpecificAssetTypes
特定のアセット・タイプのワークフロー。
object- default(optional): array default
手動起動
- id(optional): string
アセット・タイプのID。
- name(optional): string
アセット・タイプの名前
- required(optional): boolean
必須かどうか。
- startOnCreate(optional): array startOnCreate
作成時に自動開始。
object- id(optional): string
ワークフローのID。
- isEnabled(optional): boolean
OCEでワークフローが有効化または無効化されている場合。これは読取り専用フィールドです。
- name(optional): string
ワークフローの名前。これは読取り専用フィールドです。
レスポンス
- application/json
201レスポンス
object- advancedVideoEnabled(optional): boolean
リポジトリで拡張ビデオが使用可能かどうか。
- autoTagEnabled(optional): boolean
リポジトリに対して自動タグ付けを有効にするかどうか。
- channels(optional): array channels
リポジトリに関連付けられているチャネル。
- configuredLanguages(optional): array configuredLanguages
リポジトリの構成済言語。
- connectors(optional): array connectors
リポジトリに関連付けられたコネクタ。
- contentTypes(optional): array contentTypes
リポジトリに関連付けられているタイプ。
- createdBy(optional): string
リポジトリのcreatedByユーザー。
- createdDate(optional): object date
date
- customDigitalAssetsEnabled(optional): boolean
カスタム・デジタル・アセットがリポジトリに対して有効かどうか。
- defaultLanguage(optional): string
リポジトリのデフォルト言語。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。
- description(optional): string
リポジトリの説明。
- editorialRoles(optional): array editorialRoles
リポジトリに関連付けられた編集ロール。
- id(optional): string
リポジトリのId。 これはレスポンス取得と送信リクエストの必須プロパティであり、リクエストの転送には必要ありません。
- languageOptions(optional): array languageOptions
リポジトリの言語オプション。
- links(optional): array links
リンク
- name(optional): string
リポジトリの名前。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。
- notReadyEnabled(optional): boolean
リポジトリに対して準備ができていないアセットが有効になっているかどうか。
- repositoryType(optional): string
許容値:
[ "Standard", "Business" ]リポジトリのタイプ。 標準、ビジネスの値を指定できます。 デフォルト値は標準です。 - roleName(optional): string
リポジトリのユーザー・ロールの名前。
- taxonomies(optional): array taxonomies
リポジトリに関連付けられているタクソノミ。
- typeWorkflows(optional): object TypeWorkflowsBean
TypeWorkflowsBean
- updatedBy(optional): string
リポジトリのupdatedByユーザー。
- updatedDate(optional): object date
date
- viewAllCollectionsEnabled(optional): boolean
すべてのコレクションの表示がリポジトリに対して有効になっているかどうか。
- workflows(optional): array workflows
リポジトリに関連付けられたワークフロー。
array- Array of: object ChannelBeanInRepository
ChannelBeanInRepository
array- Array of: object EditorialRoleId
EditorialRoleId
object- allTypes(optional): object WorkflowsOnAllAssetTypes
すべてのアセット・タイプのワークフロー。
- types(optional): array types
特定のアセット・タイプ。
object- defaultLanguage(optional): string
デフォルト言語。
- id(optional): string
- isPrimaryChannel(optional): boolean
チャネルがアセットのプライマリかどうかを示します。
- isSiteChannel(optional): boolean
チャネルがサイト・チャネルであるかどうかをチェックします。
- isSitePlanChannel(optional): boolean
- links(optional): array links
リンク
- localizationPolicy(optional): string
チャネルのローカリゼーション・ポリシー。
- name(optional): string
- optionalLanguages(optional): array optionalLanguages
オプションの言語。
- primaryChannelSupported(optional): boolean
プライマリ・チャネルがサポートされています。
- requiredLanguages(optional): array requiredLanguages
必須言語。
object- href(optional): string
ターゲット・リソースのURI それはテンプレートURIである可能性があります。 これはレスポンス取得の必須プロパティです。
- mediaType(optional): string
メディア・タイプ。
- method(optional): string
ターゲット・リソースへのアクセスに使用できるHTTPメソッド。
- profile(optional): string
ターゲット・リソースを記述するメタデータにリンクします。
- rel(optional): string
関連タイプ これはレスポンス取得の必須プロパティです。
- templated(optional): boolean
URIがテンプレートであるかどうか。
object- connectorId(optional): string
コネクタのId。 これはレスポンス取得の必須プロパティです。
- connectorName(optional): string
コネクタの名前 これはレスポンス取得の必須プロパティです。
- connectorType(optional): string
コネクタのタイプ。 これはレスポンス取得の必須プロパティです。
- isDigitalContentConnector(optional): boolean
読取り専用:
trueデジタル・アセット・コネクタの場合はTrue、それ以外の場合はfalse - supportedContentTypes(optional): array supportedContentTypes
コネクタのサポートされているコンテンツ・タイプ。
object- name(optional): string
- typeCategory(optional): string
アセット・タイプのtypeCategory。
object- description(optional): string
カスタム編集ロールの説明。
- id: string
カスタム編集ロールのID。
- name(optional): string
カスタム編集ロールの名前。
object- default(optional): array default
手動起動
- required(optional): boolean
必須かどうか。
- startOnCreate(optional): array startOnCreate
作成時に自動開始。
array- Array of: object WorkflowsOnSpecificAssetTypes
特定のアセット・タイプのワークフロー。
object- default(optional): array default
手動起動
- id(optional): string
アセット・タイプのID。
- name(optional): string
アセット・タイプの名前
- required(optional): boolean
必須かどうか。
- startOnCreate(optional): array startOnCreate
作成時に自動開始。
object- id(optional): string
ワークフローのID。
- isEnabled(optional): boolean
OCEでワークフローが有効化または無効化されている場合。これは読取り専用フィールドです。
- name(optional): string
ワークフローの名前。これは読取り専用フィールドです。
400レスポンス
403レスポンス
404レスポンス
500レスポンス
例
次の例は、cURLを使用してRESTリソースでPOSTリクエストを発行してリポジトリを作成する方法を示しています。
curl -X POST -H 'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' 'https://host:port/content/management/api/v1.1/repositories'
例1:
これにより、名前、説明およびデフォルト言語を持つ単純なリポジトリが作成されます。en-INは言語コードです。 ペイロードを独自のデータで置換します。
/content/management/api/v1.1/repositories
リクエスト・ペイロード
{
"name": "repository1",
"description": "repository1 description.",
"defaultLanguage": "en-IN"
}
例2:
これにより、名前、説明、デフォルト言語および関連するオプション言語のリスト(en-US、enおよびdeは言語コード)を含む単純なビジネス・リポジトリが作成されます。 ペイロードを独自のデータに置き換えます。
/content/management/api/v1.1/repositories
リクエスト・ペイロード
{
"name": "repository1",
"description": "repository1 description.",
"repositoryType": "Business",
"defaultLanguage": "en-US",
"languageOptions": [
"en",
"de"
]
}
例3 :
これにより、Standardリポジトリが作成され、デフォルト言語とそれに関連付けられたオプション言語のリストが表示されます(en-US、enおよびdeは言語コードです)。 ペイロードを独自のデータで置換します。
/content/management/api/v1.1/repositories
リクエスト・ペイロード
{
"name": "repository2",
"description": "repository2 description.",
"defaultLanguage": "en-US",
"repositoryType": "Standard",
"languageOptions": [
"en",
"de"
]
}
例4 :
これにより、デフォルト言語とそれに関連付けられたタイプのリストを持つリポジトリが作成されます。 en-USは言語コードとType1で、Type2は既存のタイプの名前です。 ペイロードを独自のデータで置換します。
/content/management/api/v1.1/repositories
リクエスト・ペイロード
{
"name": "repository3",
"description": "repository3 description.",
"contentTypes": [
{
"name": "Type1"
},
{
"name": "Type2"
}
],
"defaultLanguage": "en-US"
}
例5 :
これにより、デフォルト言語で関連付けられたチャネルのリストを含むリポジトリが作成されます。 en-USは言語コードとCC1E1B4619A093A53A5378F8777746FB9E2ACCDF37A6で、CCA47722BC777B16DC5FB1452A24C5FB6D9A33EF76A2は既存のチャネルのIDです。 ペイロードを独自のデータで置換します。
/content/management/api/v1.1/repositories
リクエスト・ペイロード
{
"name": "repository4",
"description": "repository4 description.",
"channels": [
{
"id": "CC1E1B4619A093A53A5378F8777746FB9E2ACCDF37A6"
},
{
"id": "CCA47722BC777B16DC5FB1452A24C5FB6D9A33EF76A2"
}
],
"defaultLanguage": "en-US"
}
例6 :
これにより、タイプのリストが関連付けられているビジネス・リポジトリが作成されます。 Type1では、Type2は既存の型の名前です。 ペイロードを独自のデータで置換します。
/content/management/api/v1.1/repositories
リクエスト・ペイロード
{
"name": "repository5",
"description": "repository5 description.",
"contentTypes": [
{
"name": "Type1",
"typeCategory": "ContentType"
},
{
"name": "Type2",
"typeCategory": "ContentType"
},
{
"name": "myImage",
"typeCategory": "DigitalAssetType"
},
{
"name": "Image",
"typeCategory": "DigitalAssetType"
}
],
"defaultLanguage": "en-US",
"repositoryType": "Business"
}
例7 :
これにより、デフォルト言語、オプション言語のリスト、タイプのリスト、および関連付けられたチャネルのリストを含むリポジトリが作成されます。 en-US、en、deは言語コード、CC1E1B4619A093A53A5378F8777746FB9E2ACCDF37A6、CCA47722BC777B16DC5FB1452A24C5FB6D9A33EF76A2は既存のチャネルのID、Type1、Type2は既存のタイプの名前です。 ペイロードを独自のデータで置換します。
/content/management/api/v1.1/repositories
リクエスト・ペイロード
{
"name": "repository5",
"description": "repository5 description.",
"contentTypes": [
{
"name": "Type1",
"typeCategory": "ContentType"
},
{
"name": "Type2",
"typeCategory": "ContentType"
},
{
"name": "myImage",
"typeCategory": "DigitalAssetType"
},
{
"name": "Image",
"typeCategory": "DigitalAssetType"
}
],
"channels": [
{
"id": "CC1E1B4619A093A53A5378F8777746FB9E2ACCDF37A6"
},
{
"id": "CCA47722BC777B16DC5FB1452A24C5FB6D9A33EF76A2"
}
],
"defaultLanguage": "en-US",
"languageOptions": [
"en",
"de"
]
}
例8 :
これにより、タイプのリストとワークフローのリストが関連付けられているリポジトリが作成されます。 Type1、Type2は既存のタイプの名前、D7D268693C094189A6377E805482C991、B8D268693C094189A6377E805482C673は既存のワークフローIDです。 ペイロードを独自のデータで置換します。
/content/management/api/v1.1/repositories
リクエスト・ペイロード
{
"name": "repository5",
"description": "repository5 description.",
"contentTypes": [
{
"name": "Type1"
},
{
"name": "Type2"
}
],
"workflows": [
{
"id": "D7D268693C094189A6377E805482C991"
},
{
"id": "E8D268693C094189A6377E805482C954"
}
]
}
例9:
これにより、タイプのリスト、ワークフローのリストおよびアセット・タイプにワークフローが関連付けられるリポジトリが作成されます。 ペイロードを独自のデータで置換します。
/content/management/api/v1.1/repositories
リクエスト・ペイロード
{
"name": "repository5",
"description": "repository5 description.",
"contentTypes": [
{
"name": "Type1"
},
{
"name": "Type2"
}
],
"workflows": [
{
"id": "D7D268693C094189A6377E805482C991"
},
{
"id": "E8D268693C094189A6377E805482C954"
},
{
"id": "D217A8693C094189A6377E8056ER2346"
}
],
"typeWorkflows": {
"allTypes": {
"startOnCreate": [
{
"id": "D7D268693C094189A6377E805482C991"
}
],
"default": [
{
"id": "E8D268693C094189A6377E805482C954"
}
],
"required": false
},
"types": [
{
"id": "9B8395177F204AF79A6E2A0DD37CF616",
"name": "type1",
"startOnCreate": [
{
"id": "E8D268693C094189A6377E805482C954"
}
],
"default": [
{
"id": "D7D268693C094189A6377E805482C991"
}
],
"required": true
},
{
"id": "D7E395177F204AF79A6E2A0DD3723F5E",
"name": "type2",
"startOnCreate": [
{
"id": "D217A8693C094189A6377E8056ER2346"
}
],
"default": [
{
"id": "E8D268693C094189A6377E805482C954"
}
],
"required": false
}
]
}
}
例10:
これにより、デフォルト言語とそれに関連付けられたコネクタのリストを含むリポジトリが作成されます。ここで、1000および1002は、すでに有効なコネクタのIDです。 ペイロードを独自のデータで置換します。
/content/management/api/v1.1/repositories
リクエスト・ペイロード
{
"name": "repository6",
"description": "repository6 description.",
"contentTypes": [
],
"channels": [
],
"defaultLanguage": "en-US",
"connectors": [
{
"connectorId": "10000"
},
{
"connectorId": "10002"
}
]
}
例11:
これにより、名前、説明、デフォルト言語およびサポートされている拡張ビデオがタイプ(en-USは言語コード)で割り当てられるため、単純なリポジトリが作成されます。 ペイロードを独自のデータで置換します。
/content/management/api/v1.1/repositories
リクエスト・ペイロード
{
"name": "Video repository",
"description": "repository supports advanced video.",
"defaultLanguage": "en-US",
"contentTypes": [
{
"name": "Video-Plus"
}
]
}
例12:
タイプに名前、説明、デフォルト言語およびビデオ+が割り当てられたビジネス・リポジトリの作成は、ビジネス・リポジトリでサポートされていないため失敗します。
/content/management/api/v1.1/repositories
リクエスト・ペイロード
{
"name": "Video repository",
"description": "Business repository supporting advanced video.",
"defaultLanguage": "en-US",
"contentTypes": [
{
"name": "Video-Plus"
}
]
}
例13:
チャネルがビジネス・リポジトリでサポートされていないため、関連付けられているチャネルのリストを持つビジネス・リポジトリの作成は失敗します。
/content/management/api/v1.1/repositories
リクエスト・ペイロード
{
"name": "repository2",
"description": "repository2 description.",
"defaultLanguage": "en-US",
"repositoryType": "Business",
"channels": [
{
"id": "CC1E1B4619A093A53A5378F8777746FB9E2ACCDF37A6"
},
{
"id": "CCA47722BC777B16DC5FB1452A24C5FB6D9A33EF76A2"
}
]
}
例14:
これにより、タイプのリストおよびカスタム編集ロールのリストが関連付けられているリポジトリが作成されます。 ペイロードを独自のデータで置換します。
/content/management/api/v1.1/repositories
リクエスト・ペイロード
{
"name": "repository7",
"description": "repository7 description.",
"repositoryType": "Standard",
"contentTypes": [
{
"name": "Type1"
},
{
"name": "Type2"
}
],
"editorialRoles": [
{
"id": "2C8E850048FB4DB4AAE317FA74751454"
},
{
"id": "7EFD29110FE041ADAC888CCFAEE2923B"
}
],
"defaultLanguage": "en-US"
}
例15:
これにより、名前、説明およびデフォルト言語設定を含む標準リポジトリが作成され、自動タグ付け(スマート・コンテンツ)が有効になり、すべてのコレクションの表示が無効になります。 ペイロードを独自のデータで置換します。
/content/management/api/v1.1/repositories
リクエスト・ペイロード
{
"name": "repository1",
"description": "repository1 description.",
"repositoryType": "Standard",
"defaultLanguage": "en-US",
"autoTagEnabled": true,
"viewAllCollectionsEnabled": false
}
リクエスト・ヘッダー
{
"Content-Type": "application/json",
"X-Requested-With": "XMLHttpRequest"
}
レスポンス・コード
201