1. Oracle WebCenter PortalのREST API
  2. タスク
  3. portals

ポータルの作成

投稿

/v1/portal/portals

ポータルを作成して、新規作成されたポータルの情報を返します。

ポータル(nameおよびdisplayname)を作成するための必須パラメータは次のとおりです。

リクエスト

サポートされているメディア・タイプ
本文()
作成されるポータルの必須属性のコンテンツ。
ルート・スキーマ: portal
型: object
ソースを表示
ネストされたスキーマ: includedServices
タイプ: array
ソースを表示
ネストされたスキーマ: linkStates
タイプ: array
ソースを表示
ネストされたスキーマ: Locale
型: object
ソースを表示
ネストされたスキーマ: Linked
型: object
ソースを表示
ネストされたスキーマ: reference
型: object
ソースを表示
ネストされたスキーマ: LinkElementState
型: object
ソースを表示
ネストされたスキーマ: pathLinkValues
タイプ: array
ソースを表示
ネストされたスキーマ: pathLinkWildcards
タイプ: array
ソースを表示
ネストされたスキーマ: reflect.Method
型: object
ソースを表示
ネストされたスキーマ: annotatedExceptionTypes
タイプ: array
ソースを表示
ネストされたスキーマ: annotatedParameterTypes
タイプ: array
ソースを表示
ネストされたスキーマ: reflect.AnnotatedType
型: object
ソースを表示
ネストされたスキーマ: genericExceptionTypes
タイプ: array
ソースを表示
ネストされたスキーマ: genericParameterTypes
タイプ: array
ソースを表示
ネストされたスキーマ: reflect.Type
型: object
ソースを表示
ネストされたスキーマ: parameters
タイプ: array
ソースを表示
ネストされたスキーマ: typeParameters
タイプ: array
ソースを表示
ネストされたスキーマ: reflect.Parameter
型: object
ソースを表示
ネストされたスキーマ: reflect.Executable
型: object
ソースを表示
ネストされたスキーマ: annotatedExceptionTypes
タイプ: array
ソースを表示
ネストされたスキーマ: annotatedParameterTypes
タイプ: array
ソースを表示
ネストされたスキーマ: genericExceptionTypes
タイプ: array
ソースを表示
ネストされたスキーマ: genericParameterTypes
タイプ: array
ソースを表示
ネストされたスキーマ: parameters
タイプ: array
ソースを表示
ネストされたスキーマ: typeParameters
タイプ: array
ソースを表示
ネストされたスキーマ: reflect.TypeVariable
型: object
ソースを表示
ネストされたスキーマ: annotatedBounds
タイプ: array
ソースを表示
ネストされたスキーマ: bounds
タイプ: array
ソースを表示
ネストされたスキーマ: unicodeLocaleAttributes
タイプ: array
ソースを表示
ネストされたスキーマ: unicodeLocaleKeys
タイプ: array
ソースを表示
ネストされたスキーマ: linkStates
タイプ: array
ソースを表示
ネストされたスキーマ: linkStates
タイプ: array
ソースを表示
先頭に戻る

レスポンス

サポートされているメディア・タイプ

201レスポンス

ポータルが正常に作成されました。

400レスポンス

Bad request: リクエスト内の不正な形式のコンテンツ

403レスポンス

無効なutokenが指定されました。

415レスポンス

サポートされないメディア・タイプ: リクエストに必要なメディア・タイプがありません
先頭に戻る

例

REST APIを使用してポータルを作成できます。ポータルを作成すると、その作成者はデフォルトでポータルのマネージャになり、Portal Managerロールが割り当てられます。このロールでは、ポータル内でManage Security and Configuration権限が付与されます。つまり、ポータルを管理する必要があり、ポータルのプレゼンテーションとコンテンツを完全に制御できる権限を持ちます。

ポータルを作成するには、RESTリソースでPOSTリクエストを発行し、次の必須パラメータをリクエスト本文に指定する必要があります。

  • name: ポータルの名前。ポータルの名前には空白を含めず、一意になるようにしてください。

  • displayName: ユーザーに表示されるポータルの名前。

次の書式を使用し、cURLを使用してPOSTリクエストを発行します。

curl -i -X POST 
-H 'Content-Type: application/json'
-d @create-portal.json
http://hostname:port/rest/api/v1/portal/portals?utoken=utoken

説明:

  • create-portal.jsonは、リクエストのリクエスト本文を含むJSONファイルです。

  • hostname:portは、Oracle WebCenter Portalを実行中のホストとIPポートの名前です。例: example.com:8888。

  • utokenは、ポータルAPIにアクセスするためのAPIトークンです。例: utoken=utoken=abcdIC05zgjZoqCF8ShWL42AhTVvq-fc8uFshnw%2A%2A。詳細は、「認証」を参照してください。

リクエスト本文の例

次は、リクエストの本文を含むcreate-portal.jsonファイルのサンプルで、デフォルト・テンプレートを使用してポータルを作成する方法を示しています。 

{  
  "name": "HRPortal",  
  "displayName": "HR Portal",  
  "description": "Simple portal created using JSON",  
  "keywords": "portal,JSON", 
  "isPublic": true,  
 }

次は、リクエストの本文を含むcreate-portal.jsonファイルのサンプルで、カスタム・テンプレートを使用してポータルを作成する方法を示しています。 

{
  "name" : "PortalRest1",
  "displayName" : "PortalRest",
  "keywords" : "portal,JSON",
  "description" : "Advanced portal template created using JSON",
  "reference":{"name":"Template1","namespace":"portalTemplate"}
}

HTTPステータス・コード

HTTP_STATUS = 201 Created

レスポンス本文の例

この例では、新しいポータルの詳細を表示できます。ポータルの追加の情報の取得および他の操作の実行に使用される、ポータルのshortIdをメモします。たとえば、ポータルのリソース・カタログまたはスキンの情報を取得するか、ポータルにメンバーを追加します。 

{
    "resourceType": "urn:oracle:webcenter:portal:portal",
    "keywords": "portal,JSON",
    "displayName": "PortalCreationJson1585394",
    "icon": "/oracle/webcenter/siteresources/scopedMD/shared/images/portalnew_icon.png",
    "logo": "/oracle/webcenter/siteresources/scopedMD/shared/images/portalnew_logo.png",
    "preview": "/oracle/webcenter/siteresources/scopedMD/shared/images/portalnew_logo.png",
    "creationStatus": "Completed",
    "supportedLanguages": "English-US, English-UK",
    "allMailingList": "yourCommunityName@example.com",
    "adminMailingList": "yourCommunityName-admin@example.com",
    "copyrightMessage": "DeFaUlT-MeSsAgE",
    "privacyPolicyURL": "DeFaUlT-MeSsAgE",
    "securitySeededUsers": "admin",
    "securitySeededRoles": "Moderator",
    "pageCreationSettingScheme": "WCSchemeNone",
    "portalLifecycleStateMode": "active",
    "portalLifecycleStateLastChangedBy": "admin",
    "acronym": "ABC",
    "portalColor": "#000000",
    "subGSCount": 0,
    "reorderDeviceGroups": false,
    "isPublic": true,
    "memberCount": 1,
    "isSeeded": false,
    "templateName": "Portal",
    "navigationRootNode": {
        
        "resourceType": "urn:oracle:webcenter:portal:navigationnode",
        "portalName": "PortalCreationJson1528394",
        "namespace": "",
        "name": "root"
    },
    "isOnline": true,
    "isWorkflowApprovalUnsubscriptionApprovalRequired": true,
    "isBlockAllAccess": false,
    "javaFormatId": "175a26a2124d",
    "isFooterHidden": false,
    "isWorkflowApprovalSubscriptionEnableAllRoles": true,
    "isDiscoverable": true,
    "isPublishRSS": false,
    "isSelfRegistration": false,
    "isWorkflowApprovalSubscriptionApprovalRequired": true,
    "isWorkflowApprovalUnsubscriptionEnableAllRoles": true,
    "isPageCreationSettingInstantCreate": false,
    "isClosed": false,
    "description": "Simple portal created using JSON",
    "modifier": "wdmin",
     "shortId": "Aoc",
    "securityId": "space/b41a_175a26a2124d",
    "creator": "admin",
    "modified": "2018-08-08T09:09:21.518Z",
    "created": "2018-08-08T09:09:09.528Z",
    "currentVersionId": "1483-9ed7048",
    "namespace": "portal",
    "locale": "en_US",
    "id": "9df08ac6-243d-483e-b41a-175a26a2124d",
    "name": "PortalCreationJson1528994"
}
先頭に戻る