ジャンプ先

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

ポータルにメンバーを追加します

投稿

/v1/portal/portals/{portalId}/members

ポータルにメンバーを追加して、新しいメンバーの情報を取得します。ポータル・マネージャは、ポータルのメンバーとして現在WebCenter Portalに登録されているユーザーを追加できます。

メンバー(userIdおよびrole)を追加するための必須パラメータは次のとおりです。

リクエスト

パス・パラメータ

• portalId: string
  ポータルの短縮ID。

本文()

ルート・スキーマ: member

型: object

ソースを表示

• created(optional): string(date-time)
• creator(optional): string
• currentVersionId(optional): string
• description(optional): string
• documentRef(optional): string
• groupSpaceType(optional): boolean
• id(optional): string
• isGroup(optional): boolean
• link(optional): array link
• linkStates(optional): array linkStates
• locale(optional): object Locale
• modified(optional): string(date-time)
• modifier(optional): string
• name(optional): string
• namespace(optional): string
• newVersionId(optional): string
• permissionAction(optional): string
• permissionName(optional): string
• resourceType(optional): string
• role: string
  ポータル・メンバーに割り当てるロールの名前。
• securityId(optional): string
• shortId(optional): string
  ポータルのID。
• spaceId(optional): string
• userGUID(optional): string
• userId: string
  ポータル・メンバーの名前。例: karen。

{
    "required":[
        "userId",
        "role"
    ],
    "properties":{
        "userGUID":{
            "type":"string"
        },
        "role":{
            "type":"string",
            "description":"The name of the role to be assigned to the portal member."
        },
        "created":{
            "type":"string",
            "format":"date-time"
        },
        "permissionAction":{
            "type":"string"
        },
        "groupSpaceType":{
            "type":"boolean"
        },
        "shortId":{
            "type":"string",
            "description":"The Id of a portal."
        },
        "securityId":{
            "type":"string"
        },
        "permissionName":{
            "type":"string"
        },
        "documentRef":{
            "type":"string"
        },
        "isGroup":{
            "type":"boolean"
        },
        "id":{
            "type":"string"
        },
        "creator":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "locale":{
            "$ref":"#/definitions/Locale"
        },
        "userId":{
            "type":"string",
            "description":"The name of the portal member. For example, karen."
        },
        "spaceId":{
            "type":"string"
        },
        "modifier":{
            "type":"string"
        },
        "newVersionId":{
            "type":"string"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        },
        "modified":{
            "type":"string",
            "format":"date-time"
        },
        "linkStates":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkElementState"
            }
        },
        "namespace":{
            "type":"string"
        },
        "resourceType":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "currentVersionId":{
            "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"
        }
    }
}

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

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

タイプ: array

ソースを表示

• 配列: 文字列

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

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

タイプ: array

ソースを表示

• 配列: 文字列

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

先頭に戻る

レスポンス

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

• application/json

201レスポンス

ポータル・メンバーが正常に追加されました。

403レスポンス

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

先頭に戻る

例

ポータル・マネージャは、ポータルのメンバーとして現在WebCenter Portalに登録されているユーザーを追加できます。

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

• userId: ポータル・メンバーの名前。例: Karen。

• role: ポータル・メンバーに割り当てるロールの名前。

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

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

説明:

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

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

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

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

リクエスト本文の例

次は、リクエストの本文を含むcreate-member.jsonファイルのサンプルで、メンバーKarenを追加して、ユーザーロールModeratorを割り当てる方法を示しています。

{ "userId" : "Karen", "isGroup" : false, "role" : "Moderator"}

HTTPステータス・コード

HTTP_STATUS = 201 Created

レスポンス本文の例

この例では、ポータルに作成された新しいメンバーKarenの詳細を表示できます。メンバーのshortIdをメモします。

<?xml version="1.0" encoding="UTF-8"?>
<member resourceType="urn:oracle:webcenter:portal:member">
  <id>22b487b4-9a95-48e2-888b-1b75b9952af9</id >
  <shortId>Ch0</shortId>
  <name>B5A0670E7AC117790$Moderator</name>
  <creator>Admin</creator>
  <created>2018-08-06T06:21:42.92Z</created>
  <modifier>Admin</modifier>
  <modified>2018-08-06T06:21:43.757Z</modified>
  <namespace>member</namespace>
  <currentVersionId>26bc4e57-a32d-d953c</currentVersionId>
  <isGroup>false</isGroup>
  <role>Moderator</role>	
  <permissionAction>manage,update,view</permissionAction>
  <userGUID>B5A0670E7AC1443330790</userGUID>
  <userId>Karen</userId>
  <spaceId>HRPortal</spaceId>
  <groupSpaceType>true</groupSpaceType>
</member>  

先頭に戻る