テンプレートからサイトを作成
post
/documents/api/1.2/templates/{templateId}/site
既存のテンプレートからサイトを作成します。
リクエスト
サポートされるメディア・タイプ
- application/json
- application/xml
パス・パラメータ
- templateId: string
ソース・テンプレートのグローバル一意識別子(GUID)。
このパラメータには、サイトの名前であるnameパラメータなどの情報が含まれます。 サポートされている他のパラメータは、descriptionとcopyUpdatesです。
ルート・スキーマ : SitesCreateFromTemplateBody
タイプ:
objectリクエスト本文は、作成されるサイトの詳細を定義します。
ソースを表示
- copyUpdates(optional): string
ソース・サイトからの更新を新しいサイトにコピーする(1)、コピーしない(0)かどうかを示すフラグ。
- description(optional): string
作成するサイトの説明。
- name: string
作成するサイトの名前。
サイト名には次の制限があります:
- サイト名の先頭と末尾をスペースにすることはできません。
- 名前の長さは250文字を超えることはできません。
- サイト名では大文字と小文字は区別されません。つまり、
My SiteとMY SITEは同一とみなされます。
次の文字を使用しないでください:
/ \ < > * " ? : . .. | 次の文字列もサイト名には使用できません:
- documents
- sites
- authsite
- mobileauthsite
- _sitescloud
- _sitesclouddelivery
- _comps
- _components
- _compdelivery
- _idcservice
- scstemplate_*
- CON
- PRN
- AUX
- CLOCK$
- NUL
- NULL
- COM0
- COM1
- COM2
- COM3
- COM4
- COM5
- COM6
- COM7
- COM8
- COM9
- LPT0
- LPT1
- LPT2
- LPT3
- LPT4
- LPT5
- LPT6
- LPT7
- LPT8
- LPT9
- .DS_STORE
- ユーザー
- _shortcuts
- REALITEMS
- 個人ライブラリ
- 自分が共有
- 自分と共有
- お気に入り
- ごみ
リクエストの例(application/json)
{
"name":"Site Sample from Template",
"description":"Site created from an existing template",
"copyUpdates":"1"
}レスポンス
サポートされるメディア・タイプ
- application/json
- application/xml
201レスポンス
リクエストが処理されました。
ルート・スキーマ : SiteCreateFromTemplateResponse
タイプ:
objectレスポンスには、作成されたサイトの詳細が含まれます。
- createdBy(optional): object User
ユーザー情報
- createdTime(optional): string
サイトが作成された日付。
- description(optional): string
サイトの説明。
- errorCode(optional): string
エラー・コードがゼロ(0)の場合は、エラーなしです
- id(optional): string
サイトのグローバル一意識別子(GUID)。
- modifiedBy(optional): object User
ユーザー情報
- modifiedTime(optional): string
サイトが最後に変更された日付。
- name(optional): string
サイト名。
- ownedBy(optional): object User
ユーザー情報
- pseudoOwnedBy(optional): object User
ユーザー情報
- type(optional): string
アイテム・タイプ
site。
ネストされたスキーマ: User
タイプ:
objectユーザー情報
ソースを表示
- displayName(optional): string
ユーザーの表示名
- id(optional): string
ユーザーのグローバル一意識別子(GUID)。
- loginName(optional): string
ユーザーのログイン名。
- type(optional): string
アイテム・タイプ
user。
レスポンスの例(application/json)
{
"createdBy":{
"id":"U0EAA20910FAF3052ACB79E4T00000000001",
"displayName":"User AA",
"loginName":"UserAA",
"type":"user"
},
"createdTime":"2017-06-12T21:05:10Z",
"description":"Site created from an existing template",
"errorCode":"0",
"id":"F4FAEFCE084DD434A61B7CA9B5D17B95F47087F4E518",
"modifiedBy":{
"id":"U0EAA20910FAF3052ACB79E4T00000000001",
"displayName":"User AA",
"loginName":"UserAA",
"type":"user"
},
"modifiedTime":"2017-06-12T21:05:10Z",
"name":"Site Sample from Template",
"ownedBy":{
"id":"docadmin",
"displayName":"Oracle Documents Administrator",
"loginName":"docadmin",
"type":"user"
},
"pseudoOwnedBy":{
"id":"U0EAA20910FAF3052ACB79E4T00000000001",
"displayName":"User AA",
"loginName":"UserAA",
"type":"user"
},
"type":"site"
}400レスポンス
リクエスト・パラメータが正しい形式ではありません。
403レスポンス
テンプレートIDにアクセスする権限がありません。
404レスポンス
テンプレートIDがみつかりません。
409レスポンス
サイト名は既に存在します。
例
次の例では、既存のテンプレートから新しいサイトを作成します。
POST .../templates/F79233B387ECFE0E1EC5F9B2B5D17B95F47087F4E518/site
リクエスト・ヘッダー
なし。
リクエスト本文
{
"name":"Site Sample from Template",
"description":"Site created from an existing template",
"copyUpdates":"1"
}
HTTPステータス・コード
HTTP_STATUS = 201
JSONレスポンス
{
"createdBy": {
"displayName": "User AA",
"id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
"loginName": "userAALoginName",
"type": "user"
},
"createdTime": "2017-06-12T21:05:10Z",
"description": "Site created from an existing template",
"errorCode": "0",
"id": "F4DA4BC72B3CA38C532E3A0AB5D17B95F47087F4E518",
"modifiedBy": {
"displayName": "User AA",
"id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
"loginName": "userAALoginName",
"type": "user"
},
"modifiedTime": "2017-06-12T21:05:10Z",
"name": "Site Sample from Template",
"ownedBy": {
"displayName": "Oracle Documents Administrator",
"id": "docadmin",
"loginName": "docadmin",
"type": "user"
},
"pseudoOwnedBy": {
"displayName": "User AA",
"id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
"loginName": "userAALoginName",
"type": "user"
},
"type": "site"
}
例2
次の例では、既存の名前を使用して新しいサイトを作成しようとしています。
POST .../templates/F79233B387ECFE0E1EC5F9B2B5D17B95F47087F4E518/site
リクエスト・ヘッダー
なし。
リクエスト本文
{
"name":"Site Name Already Exists",
"description":"Trying to create new site using existing name",
"copyUpdates":"1"
}
HTTPステータス・コード
HTTP_STATUS = 409
JSONレスポンス
{
"errorCode": "-17",
"errorKey": "!csFldUnableToCopyItems!csFldPathAlreadyExists,Site Name Already Exists,F:SCS:SITES",
"errorMessage": "Unable to copy items. An item with name 'Site Name Already Exists' already exists at 'F:SCS:SITES'.",
"errorType": "site",
"title": "Unable to copy items. An item with name 'Site Name Already Exists' already exists at 'F:SCS:SITES'.",
"type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
例3
次の例では、無効なテンプレートIDを使用して新しいサイトを作成しようとしています。
POST .../templates/F79233B387ECFE0E1EC5F9B2B5D17B95F47087F4E518aaaa/site
リクエスト・ヘッダー
なし。
リクエスト本文
{
"name":"Site From Invalid Template",
"description":"This template does not exist",
"copyUpdates":"1"
}
HTTPステータス・コード
HTTP_STATUS = 404
JSONレスポンス
{
"copyUpdates": "1",
"description": "This template does not exist",
"errorCode": "-16",
"errorKey": "!csSecurityValidationFailed!csFldDoesNotExist,F79233B387ECFE0E1EC5F9B2B5D17B95F47087F4E5181!csUnprivilegedSystemError",
"errorMessage": "Security validation failed. 'F79233B387ECFE0E1EC5F9B2B5D17B95F47087F4E5181' does not exist. The error was caused by an internally generated issue. The error has been logged.",
"errorType": "site",
"idList": "F79233B387ECFE0E1EC5F9B2B5D17B95F47087F4E5181",
"name": "Site From Invalid Template",
"title": "Security validation failed. 'F79233B387ECFE0E1EC5F9B2B5D17B95F47087F4E5181' does not exist. The error was caused by an internally generated issue. The error has been logged.",
"type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}