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

短縮IDに基づいてポータル詳細を取得します

取得

/v1/portal/portals/{portalId}

指定された短縮IDに基づいてポータルに関する情報を返します

リクエスト

パス・パラメータ
問合せパラメータ
先頭に戻る

レスポンス

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

403レスポンス

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

404レスポンス

無効な短縮IDが指定されました
先頭に戻る

例

このエンドポイントを使用して、指定された短縮IDに基づいてポータルの詳細を取得します。

ポータルの情報を取得するには、RESTリソースでGETリクエストを発行し、詳細を取得するポータルIDを指定する必要があります。問合せパラメータを使用して、結果をフィルタできます。次の書式を使用し、cURLを使用してGETリクエストを発行します。

curl -i -X GET 
http://hostname:port/rest/api/v1/portal/portals/{portalId}?utoken=utoken
   -H 'Content-Type: application/json'

説明:

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

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

  • {portalId}は、ポータルのshort idです。ポータルのshort Idを取得するには、「ポータルの取得」を参照してください。

HTTPステータス・コード

HTTP_STATUS = 200

レスポンス本文の例

この例では、ポータルのshortIdを含む、ポータルの詳細を表示できます。JSON形式のレスポンス本文のコンテンツはJSON形式です。 

          
    "resourceType": "urn:oracle:webcenter:portal:portal",
    "keywords": "portal intranet",
    "displayName": "Avi Intranet",
    "icon": "/oracle/webcenter/space/metadata/spaces/aviintranet/images/AviIntranetIcon.png",
    "iconScaled": "/oracle/webcenter/space/metadata/spaces/aviintranet/images/AviIntranetIcon_ICON16.png",
    "logo": "/oracle/webcenter/space/metadata/spaces/aviintranet/images/AviIntranet.png",
    "logoScaled": "/oracle/webcenter/space/metadata/spaces/aviintranet/images/AviIntranet_LOGO75.png",
    "preview": "/oracle/webcenter/space/metadata/spaces/aviintranet/images/AviIntranetpreview.png",
    "previewScaled": "/oracle/webcenter/space/metadata/spaces/aviintranet/images/AviIntranetpreview_LOGO75.png",
    "creationStatus": "Completed",
    "supportedLanguages": "English-US, English-UK",
    "allMailingList": "yourCommunityName@example.com",
    "adminMailingList": "yourCommunityName-admin@example.com",
    "copyrightMessage": "DeFaUlT-MeSsAgE",
    "privacyPolicyURL": "DeFaUlT-MeSsAgE",
    "securitySeededUsers": "fmwadmin",
    "securitySeededRoles": "Moderator",
    "pageCreationSettingScheme": "WCSchemeNone",
    "portalLifecycleStateMode": "active",
    "portalLifecycleStateLastChangedBy": "fmwadmin",
    "acronym": "AI",
    "portalColor": "#84BBE6",
    "subGSCount": 0,
    "reorderDeviceGroups": false,
    "isPublic": true,
    "memberCount": 4,
    "isSeeded": false,
    "navigationRootNode": {
        "links": [
            {
                "href": "http://example.com:8888/rest/api/v1/portal/portals/Aoc/navigationRootNode?utoken=IKGspIU",
                "rel": "alternate",
                "resourceType": "urn:oracle:webcenter:portal:navigationnode",
                "capabilities": "urn:oracle:webcenter:read urn:oracle:webcenter:delete"
            },
            
        ],
        "resourceType": "urn:oracle:webcenter:portal:navigationnode",
        "namespace": "",
        "portalName": "aviintranet",
        "name": "root"
    },
    "isOnline": false,
    "isDiscoverable": true,
    "isPublishRSS": false,
    "isSelfRegistration": false,
    "isFooterHidden": false,
    "isWorkflowApprovalSubscriptionApprovalRequired": false,
    "isWorkflowApprovalSubscriptionEnableAllRoles": false,
    "isWorkflowApprovalUnsubscriptionApprovalRequired": false,
    "isWorkflowApprovalUnsubscriptionEnableAllRoles": false,
    "isPageCreationSettingInstantCreate": false,
    "isClosed": false,
    "isBlockAllAccess": false,
    "javaFormatId": "dd0a229dc",
    "namespace": "portal",
    "modifier": "admin",
    "modified": "2018-07-26T02:38:43.867Z",
    "creator": "admin",
    "currentVersionId": "39320e67-611a-48fc-bcb2-6d1a733cd5f8",
    "created": "2015-04-03T10:27:52.110Z",
    "securityId": "space/id",
    "shortId": "Aoc",
    "locale": "en_US",
    "id": "753dd0a229dc",
    "name": "aviintranet"
}
先頭に戻る