ポータルを取得します
取得
/v1/portal/portals
指定された問合せに基づいてポータルに関する情報を返します。注: 検索条件を省略すると、使用可能なポータルがすべて返されます
リクエスト
問合せパラメータ
- limit(optional): integer(int32)
返されたアイテムの最大数デフォルト値:
10
- offset(optional): integer(int32)
結果セットの最初のアイテムの位置デフォルト値:
0
- orderBy(optional): string
返されたオブジェクトを順序付けするための属性
- q(optional): string
検索条件、例: NameNamespaceQuery;name:
;namespace:portal
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
success
ネストされたスキーマ: reflect.Method
型:
ソースを表示
object
- accessible(optional): boolean
- annotatedExceptionTypes(optional): array annotatedExceptionTypes
- annotatedParameterTypes(optional): array annotatedParameterTypes
- annotatedReceiverType(optional): object reflect.AnnotatedType
- annotatedReturnType(optional): object reflect.AnnotatedType
- bridge(optional): boolean
- default(optional): boolean
- defaultValue(optional): integer
- genericExceptionTypes(optional): array genericExceptionTypes
- genericParameterTypes(optional): array genericParameterTypes
- genericReturnType(optional): object reflect.Type
- modifiers(optional): integer(int32)
- name(optional): string
- parameterCount(optional): integer(int32)
- parameters(optional): array parameters
- synthetic(optional): boolean
- typeParameters(optional): array typeParameters
- varArgs(optional): boolean
ネストされたスキーマ: reflect.Parameter
型:
ソースを表示
object
- annotatedType(optional): object reflect.AnnotatedType
- declaringExecutable(optional): object reflect.Executable
- implicit(optional): boolean
- modifiers(optional): integer(int32)
- name(optional): string
- namePresent(optional): boolean
- parameterizedType(optional): object reflect.Type
- synthetic(optional): boolean
- varArgs(optional): boolean
ネストされたスキーマ: reflect.Executable
型:
ソースを表示
object
- accessible(optional): boolean
- annotatedExceptionTypes(optional): array annotatedExceptionTypes
- annotatedParameterTypes(optional): array annotatedParameterTypes
- annotatedReceiverType(optional): object reflect.AnnotatedType
- annotatedReturnType(optional): object reflect.AnnotatedType
- genericExceptionTypes(optional): array genericExceptionTypes
- genericParameterTypes(optional): array genericParameterTypes
- modifiers(optional): integer(int32)
- name(optional): string
- parameterCount(optional): integer(int32)
- parameters(optional): array parameters
- synthetic(optional): boolean
- typeParameters(optional): array typeParameters
- varArgs(optional): boolean
ネストされたスキーマ: portal
型:
ソースを表示
object
- acronym(optional): string
- adminMailingList(optional): string
- allMailingList(optional): string
- ancestorPath(optional): string
- applicationID(optional): string
- copyrightMessage(optional): string
- created(optional): string(date-time)
- creationStatus(optional): string
- creator(optional): string
- currentVersionId(optional): string
- defaultLanguage(optional): string
- description(optional): string
- displayName: string
ユーザーに表示される、ポータルの名前。
- documentRef(optional): string
- enabledTools(optional): string
- helpPage(optional): string
- icon(optional): string
- iconScaled(optional): string
- id(optional): string
- includedServices(optional): array includedServices
- includeMembers(optional): boolean
- includeRoles(optional): boolean
- inviteWebCenterUsersEnabled(optional): string
- isBlockAllAccess(optional): boolean
- isClosed(optional): boolean
- isDiscoverable(optional): boolean
- isFooterHidden(optional): boolean
- isOnline(optional): boolean
- isPageCreationSettingInstantCreate(optional): boolean
- isPublic(optional): boolean
- isPublishRSS(optional): boolean
- isSeeded(optional): boolean
- isSelfRegistration(optional): boolean
- isWorkflowApprovalSubscriptionApprovalRequired(optional): boolean
- isWorkflowApprovalSubscriptionEnableAllRoles(optional): boolean
- isWorkflowApprovalUnsubscriptionApprovalRequired(optional): boolean
- isWorkflowApprovalUnsubscriptionEnableAllRoles(optional): boolean
- javaFormatId(optional): string
- keywords(optional): string
- link(optional): array link
- linkStates(optional): array linkStates
- locale(optional): object Locale
- loginFailedPage(optional): object Linked
- loginPage(optional): object Linked
- logo(optional): string
- logoScaled(optional): string
- memberCount(optional): integer(int32)
- modified(optional): string(date-time)
- modifier(optional): string
- name: string
ポータルの名前。ポータルの名前には空白が含まれないことに注意してください。例: HRportal。
- namespace(optional): string
- navigationRootNode(optional): object Linked
- newVersionId(optional): string
- offlinePage(optional): object Linked
- pageCreationSettingScheme(optional): string
- pageCreationStyle(optional): object Linked
- portalColor(optional): string
- portalLifecycleStateLastChangedBy(optional): string
- portalLifecycleStateLastChangedDate(optional): string(date-time)
- portalLifecycleStateMode(optional): string
- preview(optional): string
- previewScaled(optional): string
- privacyPolicyURL(optional): string
- reference(optional): object reference
- reorderDeviceGroups(optional): boolean
- resourceCatalogForGroupSpaceSiteTemplates(optional): object Linked
- resourceType(optional): string
- securityId(optional): string
- securitySeededRoles(optional): string
- securitySeededUsers(optional): string
- securitySubscriptionMessagesAddMember(optional): string
- securitySubscriptionMessagesInviteMember(optional): string
- securitySubscriptionMessagesInviteNonMember(optional): string
- selfRegistrationDefaultRole(optional): string
- selfRegistrationPage(optional): string
- serviceDataCopied(optional): string
- shortId(optional): string
- skin(optional): object Linked
- subGSCount(optional): integer(int32)
- supportedLanguages(optional): string
- workflowApprovalSubscriptionRoleWorkflows(optional): string
- workflowApprovalUnsubscriptionRoleWorkflows(optional): string
ネストされたスキーマ: Locale
型:
ソースを表示
object
- country(optional): string
- displayCountry(optional): string
- displayLanguage(optional): string
- displayName(optional): string
- displayScript(optional): string
- displayVariant(optional): string
- iSO3Country(optional): string
- iSO3Language(optional): string
- language(optional): string
- script(optional): string
- unicodeLocaleAttributes(optional): array unicodeLocaleAttributes
- unicodeLocaleKeys(optional): array unicodeLocaleKeys
- variant(optional): string
400レスポンス
Bad request: 無効な検索パラメータまたはorderByパラメータが指定されました
403レスポンス
無効なutokenが指定されました
例
エンドポイントを使用して、表示が許可されている、Oracle WebCenter Portalで使用可能なポータルのコレクションを取得します。レスポンスでは、ポータルの追加の情報の取得に使用されるshortId
を含む、各ポータルに関連する情報を表示できます。たとえば、ポータルのリソース・カタログまたはスキンの情報を取得します。問合せパラメータを使用して、結果をフィルタできます。
Oracle WebCenter Portalで使用可能なポータルの情報を取得するには、RESTリソースでGETリクエストを発行します。次の書式を使用し、cURLを使用してGETリクエストを発行します。
curl -i -X GET
http://hostname:port/rest/api/v1/portal/portals?utoken=utoken
-H 'Content-Type: application/json'
説明:
-
hostname:port
は、Oracle WebCenter Portalを実行中のホストとIPポートの名前です。例:example.com:8888
。 -
utoken
は、ポータルAPIにアクセスするためのAPIトークンです。例:utoken=utoken=abcdIC05zgjZoqCF8ShWL42AhTVvq-fc8uFshnw%2A%2A
。詳細は、「認証」を参照してください。
HTTPステータス・コード
HTTP_STATUS = 200
レスポンス本文の例
この例では、ポータルのshortId
を含む、JSON形式のレスポンス本文を表示できます。たとえば、shortId: Aiki
が強調表示されます。
{
"resourceType": "urn:oracle:webcenter:portal:portals",
"startIndex": 0,
"itemsPerPage": 10,
"items": [
{
. ,
"resourceType": "urn:oracle:webcenter:portal:portal",
"displayName": "Default Group Space Metadata",
"icon": "/oracle/webcenter/space/metadata/spaces/images/project_logo.gif",
"logo": "/oracle/webcenter/space/metadata/spaces/images/project_logo.gif",
"supportedLanguages": "English-US, English-UK",
"allMailingList": "all@example.com",
"adminMailingList": "admin@example.com",
"securitySeededUsers": "admin",
"securitySeededRoles": "Moderator",
"pageCreationSettingScheme": "WCSchemeNone",
"portalLifecycleStateMode": "active",
"portalLifecycleStateLastChangedBy": "admin",
"subGSCount": 0,
"reorderDeviceGroups": false,
"isPublic": true,
"memberCount": 0,
"isSeeded": true,
"isFooterHidden": false,
"isOnline": true,
"isDiscoverable": true,
"isPublishRSS": false,
"isSelfRegistration": false,
"isWorkflowApprovalSubscriptionApprovalRequired": true,
"isWorkflowApprovalSubscriptionEnableAllRoles": true,
"isWorkflowApprovalUnsubscriptionApprovalRequired": true,
"isWorkflowApprovalUnsubscriptionEnableAllRoles": true,
"isPageCreationSettingInstantCreate": false,
"isClosed": false,
"isBlockAllAccess": false,
"javaFormatId": "s8bba_beee_296c916a23ed",
"created": "2018-07-09T01:46:12.943Z",
"securityId": "portal/s8bbyrrf_296abcdd",
"shortId": "Aik",
"creator": "system",
"modifier": "system",
"modified": "2018-07-09T01:46:12.943Z",
"description": "This is the default group space metadata",
"namespace": "portal",
"currentVersionId": "7bd-99aa-ab34aec08163",
"locale": "en_US",
"id": "8bba98ff-296c916a23ed",
"name": "DefaultGroupSpace"
}
]
}