ジャンプ先

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

ポータルを取得します

取得

/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

本文()

ルート・スキーマ: 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を含む、各ポータルに関連する情報を表示できます。たとえば、ポータルのリソース・カタログまたはスキンの情報を取得します。問合せパラメータを使用して、結果をフィルタできます。

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"
        }
    ]
}

先頭に戻る