ジャンプ先

• リクエスト
• レスポンス
• 例

ポータルを取得します

取得

/v1/portal/portals

指定された問合せに基づいてポータルに関する情報を返します。ノート: 検索条件を省略すると、使用可能なポータルがすべて返されます

リクエスト

問合せパラメータ

• limit(optional): integer(int32)
  問合せパラメータlimitを使用して、取得するアイテムについて、レスポンス本文の1ページ当たりの最大数を指定できます。

  制限を設定するフォーマットは、&limit=1ページ当たりのアイテム数です。

  デフォルトでは、制限は1ページ当たり10のアイテムに設定されています。

  例: 次の例に、1ページ当たりのアイテム数を5に制限する方法を示します

  http://host:port/rest/api/v1/portal/portals?utoken=access_token&limit=5.

  デフォルト値: 10
• offset(optional): integer(int32)
  問合せパラメータoffsetを使用して、最初に取得されるアイテムの位置を指定できます。

  オフセットを設定するフォーマットは、&offset=offset_numberです

  デフォルトでは、オフセットの値は0に設定されています。

  例: 次の例に、オフセットを5に設定する方法を示します:

  http://host:port/rest/api/v1/portal/portals?utoken=access_token&offset=5

  デフォルト値: 0
• orderBy(optional): string
  orderByパラメータを使用して、取得したアイテムを昇順または降順にソートできます。

  • 昇順でソートするには、ascを使用します(例: &orderBy=name:asc)
  • 降順でソートするには、descを使用します(例: &orderBy=name:desc)

  ノート:

  • 常に、QueryObjectでorderBy問合せパラメータを使用します。
  • orderByパラメータで使用できる属性は、name、shortId、createdおよびmodifiedの4つのみです。

  例: 次の例に、orderByパラメータを使用して、取得されたアイテムを名前属性に基づき昇順でソートする方法を示します:

  http://host:port/rest/api/v1/portal/portals?utoken=access_token&q=NameLikeQuery;name:HR%&orderBy=name:asc

  この例では、qパラメータはq=NameLikeQuery;name:HR%です。ここで、問合せオブジェクトはNameLikeQueryで、問合せ属性はnameです。この問合せは名前がHRで始まるすべてのポータルを返し、名前属性が昇順でソートされます。

• q(optional): string

  問合せパラメータqを使用して、問合せオブジェクトに基づいて取得したアイテムをフィルタできます。

  次に、問合せパラメータを使用する構文を示します:

  q=QueryObject;queryAttribute:'searchAttribute'

  例: q=DisplayNameQuery;displayName:DemoPortal

  • QueryObject: この例ではDisplayNameQueryが問合せに使用されます。サポートされているQueryObjectのみを使用してください。WebCenter Portalでサポートされる問合せオブジェクトのリストは、次を参照してください。
  • queryAttribute: 指定されたQueryObjectでサポートされる属性。この例では、displayNameがDisplayNameQueryの属性の1つです。指定したQueryObjectでサポートされる問合せ属性については、Oracle WebCenter Portal Java APIリファレンスを参照してください。
  • searchAttribute: queryAttributeの値を指定します。この例では、ポータルのdisplayNameであるDemoPortalを使用します。

  WebCenter PortalでサポートされているqueryObjectsは次のとおりです。

  • DisplayNameQuery: この問合せを使用して、ポータルの特定の表示名を検索します。

    例: 次の例に、HRPortalという名前のポータルの検索方法を示します:

    http://host:port/rest/api/v1/portal/portals?utoken=accesstoken&q=DisplayNameQuery;displayName:HRPortal

  • NameLikeQuery: この問合せを使用して、特定の名前属性を検索します。

    検索文字列をHRなどの名前属性に指定する必要があります。検索文字列に文字%を追加すると、検索文字列で始まる単語を含むすべてのポータルが取得されます:

    例: 次の例に、「HR」という語で始まるポータル名の検索方法を示します:

    http://host:port/rest/api/v1/portal/portals?utoken=access_token&q=NameLikeQuery;name:HR%

  • NameQuery: この問合せを使用して、ポータル名に基づいて検索します。

    問合せパラメータ値として完全なポータル名を指定します。

    例: 次の例に、DemoPortalというポータル名の検索方法を示します:

    http://host:port/rest/api/v1/portal/portals?utoken=access_token&&q=NameQuery;name:DemoPortal

  • DiscoverablePortalQuery: この問合せを使用して、ユーザーが表示のために認証される検出可能なすべてのポータルを取得します。

    次の例に、検出可能なすべてのポータルを取得する方法を示します:

    http://host:port/rest/api/v1/portal/portals?utoken=access_token&q=DiscoverablePortalQuery

  • JoinedPortalQuery: この問合せを使用して、ログイン・ユーザーがメンバーであるすべてのポータルを取得します。

    次の例に、JoinedPortalQueryを使用してすべてのポータルを取得する方法を示します:

    http://host:port/rest/api/v1/portal/portals?utoken=access_token&q=JoinedPortalQuery

  • DefaultPortalQuery: この問合せを使用して、Oracle WebCenter Portalですぐに使用できるDefaultGroupSpaceを取得します。

    http://host:port/rest/api/v1/portal/portals?utoken=access_token&q=DefaultPortalQuery

  • AllPortalQuery

    この例では、問合せによって、ログイン・ユーザーがメンバーであるすべてのポータルが返されます。

    http://host:port/rest/api/v1/portal/portals?utoken=access_token=AllPortalQuery

  • JoinedOrPublicPortalQuery: この問合せを使用して、ログイン・ユーザーがメンバーであるすべてのパブリック・ポータルおよびポータルを取得します。

    http://host:port/rest/api/v1/portal/portals?utoken=access_token&q=JoinedOrPublicPortalQuery

  • PublicPortalQuery: この問合せを使用して、すべてのパブリック・ポータルを取得します:

    http://host:port/rest/api/v1/portal/portals?utoken=access_token&q=AllPortalQuery.

    この例では、adminフラグがtrueに設定されています。この問合せは、ログイン・ユーザーがメンバーであり、かつパブリック・ポータルであるすべてのポータルを返します:

    http://host:port/rest/api/v1/portal/portals?utoken=access_token&q=AllPortalQuery;admin:true

  • NameDescriptionLikeQuery: この問合せを使用して、queryAttribute名で指定された値と一致するポータル名と説明を取得します。使用できるqueryAttribute名は1つのみです。

    次の例に、NameDescriptionLikeQueryを使用した問合せの方法を示します:

    http://host:port/rest/api/v1/portal/portals?utoken=access_token&q=NameDescriptionLikeQuery;name:HR%

    この例では、HRで始まる名前または説明を持つすべてのポータルが取得されます。

  • ModeratedPortalQuery: この問合せを使用して、ログイン・ユーザーがモデレータであるすべてのポータルを取得します。

    http://host:port/rest/api/v1/portal/portals?utoken=access_token&q=ModeratedPortalQuery

  • NameNamespaceQuery: この問合せでは、名前とネームスペースの2つの属性が使用されます。ネームスペースには、portal、page、pagestyleなどを指定できます。nameパラメータは、入力パラメータとしてポータル名を取ります。

    http://host:port/rest/api/v1/portal/portals?utoken=access_token&q=NameNamespaceQuery;name:HRPortal;namespace:portal

    この例では、name属性が使用されています。これはHRPortalというポータル名です。namespace属性が2番目の属性として使用され、値portalが指定されています。この問合せは、ポータル名がHRPortalと一致するポータルを返します。

  • SinceQuery: この問合せを使用して、特定の日付以降に変更された特定のタイプのアイテムをすべて取得します。日付の書式は、yyyy-MM-dd'T'HH:mm:ss.SSSXです

    例: SinceQuery;date:2001-07-04T12:08:56.235-0700

    次の例に、日付2018-11-19T12:08:56.235-0700より前に変更されたすべてのポータルを取得する方法を示します:

    http://host:port/rest/api/v1/portal/portals?utoken=access_token&q=SinceQuery;date:2018-11-19T12:08:56.235-0700

先頭に戻る

レスポンス

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

• application/json

200レスポンス

success

本文()

ルート・スキーマ: schema

タイプ: array

ソースを表示

• 配列: オブジェクト portals

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/portals"
    }
}

ネストされたスキーマ: portals

型: object

ソースを表示

• itemsPerPage(optional): integer(int32)
• link(optional): array link
• linkStates(optional): array linkStates
• portal(optional): array portal
• resourceType(optional): string
• startIndex(optional): integer(int32)
• totalResults(optional): integer(int32)

{
    "properties":{
        "itemsPerPage":{
            "type":"integer",
            "format":"int32"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        },
        "linkStates":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkElementState"
            }
        },
        "portal":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/portal"
            }
        },
        "resourceType":{
            "type":"string"
        },
        "startIndex":{
            "type":"integer",
            "format":"int32"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        }
    }
}

ネストされたスキーマ: link

タイプ: array

ソースを表示

• 配列: オブジェクト link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

ネストされたスキーマ: linkStates

タイプ: array

ソースを表示

• 配列: オブジェクト LinkElementState

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkElementState"
    }
}

ネストされたスキーマ: portal

タイプ: array

ソースを表示

• 配列: オブジェクト portal

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/portal"
    }
}

ネストされたスキーマ: link

型: object

ソースを表示

• capabilities(optional): string
• contentType(optional): string
• href(optional): string
• rel(optional): string
• resourceType(optional): string
• template(optional): string
• title(optional): string
• type(optional): string

{
    "properties":{
        "contentType":{
            "type":"string"
        },
        "resourceType":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "capabilities":{
            "type":"string"
        },
        "template":{
            "type":"string"
        },
        "title":{
            "type":"string"
        }
    }
}

ネストされたスキーマ: LinkElementState

型: object

ソースを表示

• href(optional): boolean
• path(optional): string
• pathLinkValues(optional): array pathLinkValues
• pathLinkWildcards(optional): array pathLinkWildcards
• resourceMethod(optional): object reflect.Method
• resourceType(optional): string
• root(optional): boolean
• template(optional): boolean

{
    "properties":{
        "resourceType":{
            "type":"string"
        },
        "root":{
            "type":"boolean"
        },
        "path":{
            "type":"string"
        },
        "template":{
            "type":"boolean"
        },
        "pathLinkValues":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "pathLinkWildcards":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "href":{
            "type":"boolean"
        },
        "resourceMethod":{
            "$ref":"#/definitions/reflect.Method"
        }
    }
}

ネストされたスキーマ: pathLinkValues

タイプ: array

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: pathLinkWildcards

タイプ: array

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: 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

{
    "properties":{
        "genericExceptionTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.Type"
            }
        },
        "genericParameterTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.Type"
            }
        },
        "varArgs":{
            "type":"boolean"
        },
        "annotatedReturnType":{
            "$ref":"#/definitions/reflect.AnnotatedType"
        },
        "parameterCount":{
            "type":"integer",
            "format":"int32"
        },
        "annotatedReceiverType":{
            "$ref":"#/definitions/reflect.AnnotatedType"
        },
        "bridge":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "annotatedExceptionTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.AnnotatedType"
            }
        },
        "accessible":{
            "type":"boolean"
        },
        "modifiers":{
            "type":"integer",
            "format":"int32"
        },
        "synthetic":{
            "type":"boolean"
        },
        "genericReturnType":{
            "$ref":"#/definitions/reflect.Type"
        },
        "defaultValue":{
            "type":"integer"
        },
        "annotatedParameterTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.AnnotatedType"
            }
        },
        "parameters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.Parameter"
            }
        },
        "typeParameters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.TypeVariable"
            }
        },
        "default":{
            "type":"boolean"
        }
    }
}

ネストされたスキーマ: annotatedExceptionTypes

タイプ: array

ソースを表示

• 配列: オブジェクト reflect.AnnotatedType

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.AnnotatedType"
    }
}

ネストされたスキーマ: annotatedParameterTypes

タイプ: array

ソースを表示

• 配列: オブジェクト reflect.AnnotatedType

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.AnnotatedType"
    }
}

ネストされたスキーマ: reflect.AnnotatedType

型: object

ソースを表示

• type(optional): object reflect.Type

{
    "properties":{
        "type":{
            "$ref":"#/definitions/reflect.Type"
        }
    }
}

ネストされたスキーマ: genericExceptionTypes

タイプ: array

ソースを表示

• 配列: オブジェクト reflect.Type

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.Type"
    }
}

ネストされたスキーマ: genericParameterTypes

タイプ: array

ソースを表示

• 配列: オブジェクト reflect.Type

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.Type"
    }
}

ネストされたスキーマ: reflect.Type

型: object

ソースを表示

• typeName(optional): string

{
    "properties":{
        "typeName":{
            "type":"string"
        }
    }
}

ネストされたスキーマ: parameters

タイプ: array

ソースを表示

• 配列: オブジェクト reflect.Parameter

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.Parameter"
    }
}

ネストされたスキーマ: typeParameters

タイプ: array

ソースを表示

• 配列: オブジェクト reflect.TypeVariable

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.TypeVariable"
    }
}

ネストされたスキーマ: 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

{
    "properties":{
        "varArgs":{
            "type":"boolean"
        },
        "implicit":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "namePresent":{
            "type":"boolean"
        },
        "annotatedType":{
            "$ref":"#/definitions/reflect.AnnotatedType"
        },
        "modifiers":{
            "type":"integer",
            "format":"int32"
        },
        "synthetic":{
            "type":"boolean"
        },
        "declaringExecutable":{
            "$ref":"#/definitions/reflect.Executable"
        },
        "parameterizedType":{
            "$ref":"#/definitions/reflect.Type"
        }
    }
}

ネストされたスキーマ: 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

{
    "properties":{
        "genericExceptionTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.Type"
            }
        },
        "genericParameterTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.Type"
            }
        },
        "varArgs":{
            "type":"boolean"
        },
        "annotatedReturnType":{
            "$ref":"#/definitions/reflect.AnnotatedType"
        },
        "parameterCount":{
            "type":"integer",
            "format":"int32"
        },
        "annotatedReceiverType":{
            "$ref":"#/definitions/reflect.AnnotatedType"
        },
        "name":{
            "type":"string"
        },
        "annotatedExceptionTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.AnnotatedType"
            }
        },
        "accessible":{
            "type":"boolean"
        },
        "modifiers":{
            "type":"integer",
            "format":"int32"
        },
        "synthetic":{
            "type":"boolean"
        },
        "annotatedParameterTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.AnnotatedType"
            }
        },
        "parameters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.Parameter"
            }
        },
        "typeParameters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.TypeVariable"
            }
        }
    }
}

ネストされたスキーマ: annotatedExceptionTypes

タイプ: array

ソースを表示

• 配列: オブジェクト reflect.AnnotatedType

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.AnnotatedType"
    }
}

ネストされたスキーマ: annotatedParameterTypes

タイプ: array

ソースを表示

• 配列: オブジェクト reflect.AnnotatedType

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.AnnotatedType"
    }
}

ネストされたスキーマ: genericExceptionTypes

タイプ: array

ソースを表示

• 配列: オブジェクト reflect.Type

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.Type"
    }
}

ネストされたスキーマ: genericParameterTypes

タイプ: array

ソースを表示

• 配列: オブジェクト reflect.Type

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.Type"
    }
}

ネストされたスキーマ: parameters

タイプ: array

ソースを表示

• 配列: オブジェクト reflect.Parameter

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.Parameter"
    }
}

ネストされたスキーマ: typeParameters

タイプ: array

ソースを表示

• 配列: オブジェクト reflect.TypeVariable

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.TypeVariable"
    }
}

ネストされたスキーマ: reflect.TypeVariable

型: object

ソースを表示

• annotatedBounds(optional): array annotatedBounds
• bounds(optional): array bounds
• name(optional): string

{
    "properties":{
        "bounds":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.Type"
            }
        },
        "annotatedBounds":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.AnnotatedType"
            }
        },
        "name":{
            "type":"string"
        }
    }
}

ネストされたスキーマ: annotatedBounds

タイプ: array

ソースを表示

• 配列: オブジェクト reflect.AnnotatedType

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.AnnotatedType"
    }
}

ネストされたスキーマ: bounds

タイプ: array

ソースを表示

• 配列: オブジェクト reflect.Type

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.Type"
    }
}

ネストされたスキーマ: 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

{
    "required":[
        "name",
        "displayName"
    ],
    "properties":{
        "serviceDataCopied":{
            "type":"string"
        },
        "skin":{
            "$ref":"#/definitions/Linked"
        },
        "resourceCatalogForGroupSpaceSiteTemplates":{
            "$ref":"#/definitions/Linked"
        },
        "selfRegistrationPage":{
            "type":"string"
        },
        "enabledTools":{
            "type":"string"
        },
        "created":{
            "type":"string",
            "format":"date-time"
        },
        "pageCreationStyle":{
            "$ref":"#/definitions/Linked"
        },
        "securitySubscriptionMessagesAddMember":{
            "type":"string"
        },
        "workflowApprovalSubscriptionRoleWorkflows":{
            "type":"string"
        },
        "logoScaled":{
            "type":"string"
        },
        "securitySeededRoles":{
            "type":"string"
        },
        "reorderDeviceGroups":{
            "type":"boolean"
        },
        "isPublishRSS":{
            "type":"boolean"
        },
        "includeMembers":{
            "type":"boolean"
        },
        "subGSCount":{
            "type":"integer",
            "format":"int32"
        },
        "isWorkflowApprovalSubscriptionApprovalRequired":{
            "type":"boolean"
        },
        "includedServices":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "displayName":{
            "type":"string",
            "description":"Name of the portal as displayed to users.",
            "required":true
        },
        "shortId":{
            "type":"string"
        },
        "securitySeededUsers":{
            "type":"string"
        },
        "securityId":{
            "type":"string"
        },
        "previewScaled":{
            "type":"string"
        },
        "workflowApprovalUnsubscriptionRoleWorkflows":{
            "type":"string"
        },
        "loginPage":{
            "$ref":"#/definitions/Linked"
        },
        "isWorkflowApprovalSubscriptionEnableAllRoles":{
            "type":"boolean"
        },
        "documentRef":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "privacyPolicyURL":{
            "type":"string"
        },
        "pageCreationSettingScheme":{
            "type":"string"
        },
        "securitySubscriptionMessagesInviteMember":{
            "type":"string"
        },
        "creationStatus":{
            "type":"string"
        },
        "navigationRootNode":{
            "$ref":"#/definitions/Linked"
        },
        "acronym":{
            "type":"string"
        },
        "selfRegistrationDefaultRole":{
            "type":"string"
        },
        "isSeeded":{
            "type":"boolean"
        },
        "creator":{
            "type":"string"
        },
        "name":{
            "type":"string",
            "description":"Name of the portal. Note the name of the portal is without space. For example, HRportal."
        },
        "isWorkflowApprovalUnsubscriptionEnableAllRoles":{
            "type":"boolean"
        },
        "locale":{
            "$ref":"#/definitions/Locale"
        },
        "isBlockAllAccess":{
            "type":"boolean"
        },
        "isDiscoverable":{
            "type":"boolean"
        },
        "isClosed":{
            "type":"boolean"
        },
        "modifier":{
            "type":"string"
        },
        "ancestorPath":{
            "type":"string"
        },
        "helpPage":{
            "type":"string"
        },
        "keywords":{
            "type":"string"
        },
        "reference":{
            "$ref":"#/definitions/reference"
        },
        "portalLifecycleStateMode":{
            "type":"string"
        },
        "newVersionId":{
            "type":"string"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        },
        "includeRoles":{
            "type":"boolean"
        },
        "isSelfRegistration":{
            "type":"boolean"
        },
        "supportedLanguages":{
            "type":"string"
        },
        "offlinePage":{
            "$ref":"#/definitions/Linked"
        },
        "portalLifecycleStateLastChangedBy":{
            "type":"string"
        },
        "portalLifecycleStateLastChangedDate":{
            "type":"string",
            "format":"date-time"
        },
        "modified":{
            "type":"string",
            "format":"date-time"
        },
        "copyrightMessage":{
            "type":"string"
        },
        "securitySubscriptionMessagesInviteNonMember":{
            "type":"string"
        },
        "isWorkflowApprovalUnsubscriptionApprovalRequired":{
            "type":"boolean"
        },
        "logo":{
            "type":"string"
        },
        "javaFormatId":{
            "type":"string"
        },
        "isPageCreationSettingInstantCreate":{
            "type":"boolean"
        },
        "memberCount":{
            "type":"integer",
            "format":"int32"
        },
        "adminMailingList":{
            "type":"string"
        },
        "inviteWebCenterUsersEnabled":{
            "type":"string"
        },
        "linkStates":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkElementState"
            }
        },
        "portalColor":{
            "type":"string"
        },
        "namespace":{
            "type":"string"
        },
        "resourceType":{
            "type":"string"
        },
        "preview":{
            "type":"string"
        },
        "isPublic":{
            "type":"boolean"
        },
        "allMailingList":{
            "type":"string"
        },
        "isFooterHidden":{
            "type":"boolean"
        },
        "loginFailedPage":{
            "$ref":"#/definitions/Linked"
        },
        "iconScaled":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "applicationID":{
            "type":"string"
        },
        "currentVersionId":{
            "type":"string"
        },
        "defaultLanguage":{
            "type":"string"
        },
        "isOnline":{
            "type":"boolean"
        },
        "icon":{
            "type":"string"
        }
    }
}

ネストされたスキーマ: includedServices

タイプ: array

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: link

タイプ: array

ソースを表示

• 配列: オブジェクト link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

ネストされたスキーマ: linkStates

タイプ: array

ソースを表示

• 配列: オブジェクト LinkElementState

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkElementState"
    }
}

ネストされたスキーマ: 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

{
    "properties":{
        "iSO3Country":{
            "type":"string"
        },
        "country":{
            "type":"string"
        },
        "displayCountry":{
            "type":"string"
        },
        "displayVariant":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "script":{
            "type":"string"
        },
        "iSO3Language":{
            "type":"string"
        },
        "displayLanguage":{
            "type":"string"
        },
        "unicodeLocaleAttributes":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "unicodeLocaleKeys":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "language":{
            "type":"string"
        },
        "variant":{
            "type":"string"
        },
        "displayScript":{
            "type":"string"
        }
    }
}

ネストされたスキーマ: Linked

型: object

ソースを表示

• link(optional): array link
• linkStates(optional): array linkStates
• resourceType(optional): string

{
    "properties":{
        "resourceType":{
            "type":"string"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        },
        "linkStates":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkElementState"
            }
        }
    }
}

ネストされたスキーマ: reference

型: object

ソースを表示

• link(optional): array link
• linkStates(optional): array linkStates
• name(optional): string
  ポータルの名前
• namespace(optional): string
• portalName(optional): string
• resourceType(optional): string

{
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the Portal",
            "required":true
        },
        "resourceType":{
            "type":"string"
        },
        "namespace":{
            "type":"string"
        },
        "portalName":{
            "type":"string"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        },
        "linkStates":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkElementState"
            }
        }
    }
}

ネストされたスキーマ: unicodeLocaleAttributes

タイプ: array

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: unicodeLocaleKeys

タイプ: array

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: link

タイプ: array

ソースを表示

• 配列: オブジェクト link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

ネストされたスキーマ: linkStates

タイプ: array

ソースを表示

• 配列: オブジェクト LinkElementState

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkElementState"
    }
}

ネストされたスキーマ: link

タイプ: array

ソースを表示

• 配列: オブジェクト link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

ネストされたスキーマ: linkStates

タイプ: array

ソースを表示

• 配列: オブジェクト LinkElementState

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkElementState"
    }
}

400レスポンス

Bad request: 無効な検索パラメータまたはorderByパラメータが指定されました

403レスポンス

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

先頭に戻る

例

エンドポイントを使用して、表示が許可されている、Oracle WebCenter Portalで使用可能なポータルのコレクションを取得します。レスポンスでは、ポータルの追加の情報の取得に使用されるshortIdを含む、各ポータルに関連する情報を表示できます。たとえば、ポータルのリソース・カタログまたはスキンの情報を取得します。

ノート: 問合せパラメータを使用して、結果のページ区切り、ソートまたはフィルタ処理を行うことができます。このエンドポイントでサポートされる問合せパラメータは、limit、offset、orderBy、qです。

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": "[e-mail]",
            "adminMailingList": "[e-mail]",
            "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"
        }
    ]
}

REST APIでのページ区切りの使用

WebCenter Portalでポータルを取得す場合、表示する結果が多くなります。そのため、limit、offsetなどの問合せパラメータを使用して、結果にページ区切りを使用できます。

このエンドポイントでサポートされる問合せパラメータは、limit、offset、orderBy、qです。

GETメソッドを使用して情報を取得する場合、デフォルトでは1ページ当たり10のアイテムが表示されます。limit問合せパラメータを使用して、ページ当たりのアイテム数を設定できます。

次の例に、ページ当たりのアイテム数を2に設定する方法を示します:

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

ページ当たり2つのアイテムのみを表示するレスポンス本文は、次のとおりです:

{
    
    
    "resourceType": "urn:oracle:webcenter:portal:portals",
    "startIndex": 0,
    "itemsPerPage": 2,
    "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": "[e-mail]",
            "adminMailingList": "[e-mail]",
            "securitySeededUsers": "admin",
            "securitySeededRoles": "Moderator",
            "pageCreationSettingScheme": "WCSchemeNone",
            "portalLifecycleStateMode": "active",
            
            "id": "8bba98ff-296c916a23ed",
            "name": "DefaultGroupSpace"
        },
     "resourceType": "urn:oracle:webcenter:portal:portal",
            "keywords": "portal",
            "displayName": "Portal1",
            "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": "[e-mail]",
            "adminMailingList": "[e-mail]",

            "id": "82e88931-1093-4e31-95bc-b5b6935b6d4e",
            "name": "HRPortal
        }
      ]
}
            
      

たとえば、カタログ内に取得するアイテムが10あるが、今はページごとに2つのアイテムのみを取得する必要があります。その後で、3番目のアイテムの結果を表示する必要があります。

3番目のアイテムの結果を表示するには、offset問合せパラメータを使用して開始位置を設定する必要があります。

次の例に、3番目のアイテムの結果を表示するために、オフセットを3に設定する方法を示します:

curl -i -X GET 
http://hostname:port/rest/api/v1/portal/portals?utoken=utoken&offset=3&limit=2
-H 'Content-Type: application/json'

次に示すレスポンス本文には3番目のアイテムの結果が示され、さらに1ページ当たり2つのみのアイテムが示されています:

{
    
    
    "resourceType": "urn:oracle:webcenter:portal:portals",
    "startIndex": 3,
    "itemsPerPage": 2,
    "items": [
    
    "resourceType": "urn:oracle:webcenter:portal:portal",
            "displayName": "AVi Intranete",
            "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": "[e-mail]",
            
            
            "id": "23454a98ff-296c916a23ed",
            "name": "AViIntranete"
        },
     "resourceType": "urn:oracle:webcenter:portal:portal",
            "keywords": "portal",
            "displayName": "Avi Portal1",
            "icon": "/oracle/webcenter/siteresources/scopedMD/shared/images/portalnew_icon.png",
            "logo": "/oracle/webcenter/siteresources/scopedMD/shared/images/portalnew_logo.png",
            

            "id": "45677-1093-95bc-b5b6935b6d4e",
            "name": "AviPortal
        }
      ]
}
            
      

ソート

WebCenter Portalでは、問合せパラメータを使用して、取得するアイテムをソートできます。この例は、orderByパラメータを使用して、名前属性を昇順でソートする方法を示しています:

ノート: サポートされる他の問合せパラメータについては、「問合せパラメータ」セクションを参照してください。

curl -i -X GET 
http://hostname:port/rest/api/v1/portal/portals?utoken=utoken&q=NameLikeQuery;name:HR%&orderBy=name:asc&limit=3
-H 'Content-Type: application/json'

次の例に、ポータル名が昇順でソートされたレスポンス本文を示します:

{
    
    "resourceType": "urn:oracle:webcenter:portal:portals",
    "startIndex": 0,
    "itemsPerPage": 3,
    "items": [
        
            "resourceType": "urn:oracle:webcenter:portal:portal",
            "keywords": "portal,JSON",
            "displayName": "HR Finance Portal",
            "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",
            
            
                "resourceType": "urn:oracle:webcenter:portal:navigationnode",
                "portalName": "HRFinancePortal",
                "namespace": "",
                "name": "root"
            },
            
            "shortId": "Amc",
            "namespace": "portal",
            "locale": "en_US",
            "id": "e2a986b8-7c1e655ba",
            "name": "HRFinancePortal"
        },
        
            "resourceType": "urn:oracle:webcenter:portal:portal",
            "keywords": "portal,JSON",
            "displayName": "HR MY Portal",
            "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",
            
            
                "resourceType": "urn:oracle:webcenter:portal:navigationnode",
                "portalName": "HRMyPortal",
                "namespace": "",
                "name": "root"
            },
            
            "shortId": "Als",
            "namespace": "portal",
            "locale": "en_US",
            "id": "5608eed1-893472d",
            "name": "HRMyPortal"
        },
        
            "resourceType": "urn:oracle:webcenter:portal:portal",
            "keywords": "portal,JSON",
            "displayName": "HR Portal",
            "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",
           
            
                "resourceType": "urn:oracle:webcenter:portal:navigationnode",
                "portalName": "HRPortal",
                "namespace": "",
                "name": "root"
            },
            
            "shortId": "Ak8",
            "namespace": "portal",
            "locale": "en_US",
            "id": "3bc82a91-03958d8e",
            "name": "HRPortal"
        }
    ]
}

先頭に戻る