Oracle Fusion Cloud Applicationsの共通機能のためのREST API

機械翻訳について

すべてのロールの取得

get

/hcmRestApi/scim/Roles

すべてのロールの取得

リクエスト

問合せパラメータ

attributes: string

このパラメータは、レスポンスに含める属性値のカンマ区切りリストを指定します。
count: integer

このパラメータは、現在の範囲内で返されるリソース・インスタンス数を指定します。
filter: string

このパラメータは、リソース・インスタンスのサブセットを取得する問合せ式を指定します。書式: ?filter= 例: filter=firstName prおよびuserType eq Employee
sortBy: string

このパラメータは、リソース・コレクションのソート基準となる属性を指定します。書式: ?sortBy=。属性名は単純な属性の場合はの書式、複雑な属性の場合はの書式である必要があります。例: sortBy=category
sortOrder: string

このパラメータは、リソース・コレクションがordered.Exampleである属性を指定: sortOrder=ascending
startIndex: integer

このパラメータは、レスポンスに含まれる最初の結果に対して1ベースの索引の使用を指定します。ページ区切りを使用するには、この問合せパラメータを指定してください。

この操作にはリクエスト本文がありません。

トップに戻る

レスポンス

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

application/json

デフォルト・レスポンス

次の表に、このタスクのデフォルト・レスポンスを示します。

ルート・スキーマ : ロール

タイプ: object

Show Source

itemsPerPage: integer

タイトル: Count

現在の範囲内で返されるリソース・インスタンス数。
Resources: array Resources

タイトル: Resources

コレクション内のロール。
startIndex: integer

タイトル: start index

リソース・コレクションの開始位置。たとえば、startIndexが11でitemsPerPageが10の場合、レスポンス本文には11から20までの行が含まれます。

{
    "type":"object",
    "properties":{
        "itemsPerPage":{
            "title":"Count",
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "startIndex":{
            "title":"start index",
            "type":"integer",
            "description":"The starting position in the resource collection. For example, if startIndex is 11 and itemsPerPage is 10, the response body contains rows from 11 to 20."
        },
        "Resources":{
            "title":"Resources",
            "type":"array",
            "description":"The roles in the collection.",
            "items":{
                "$ref":"#/components/schemas/Roles-item"
            }
        }
    }
}

ネストされたスキーマ : リソース

タイプ: array

タイトル: Resources

コレクション内のロール。

Show Source

Array of: object Roles-item

{
    "title":"Resources",
    "type":"array",
    "description":"The roles in the collection.",
    "items":{
        "$ref":"#/components/schemas/Roles-item"
    }
}

ネストされたスキーマ : Roles-item

タイプ: object

Show Source

category: string

タイトル: Category

ロールのカテゴリ(マネージャなど)。
description: string

タイトル: Description

ロールの説明。このロールを持つユーザーが実行できる機能などの情報が含まれます。
displayName: string

タイトル: DisplayName

ロールの表示名です。
id: string

タイトル: Id

Oracle Applications Cloudのロールの一意の識別子。
members: array Members

タイトル: Members

ロールに割り当てられたユーザーのリストです。
meta: object meta

タイトル: meta

ロール・リソースのメタデータ。
name: string

タイトル: Name

ロールの名前です。
schemas: array Schemas

タイトル: Schemas

ロール・リソースのスキーマ。

{
    "type":"object",
    "properties":{
        "schemas":{
            "title":"Schemas",
            "type":"array",
            "description":"The schema of the roles resource.",
            "items":{
                "type":"string"
            }
        },
        "meta":{
            "title":"meta",
            "type":"object",
            "description":"The metadata of the roles resource."
        },
        "id":{
            "title":"Id",
            "type":"string",
            "description":"A unique identifier for the role in Oracle Applications Cloud."
        },
        "name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the role."
        },
        "displayName":{
            "title":"DisplayName",
            "type":"string",
            "description":"The display name for the role."
        },
        "description":{
            "title":"Description",
            "type":"string",
            "description":"The description of the role, which includes informations such as the functions that a user with this role can perform."
        },
        "category":{
            "title":"Category",
            "type":"string",
            "description":"The category of the role, for example Manager."
        },
        "members":{
            "title":"Members",
            "type":"array",
            "description":"A list of users assigned to the role.",
            "items":{
                "$ref":"#/components/schemas/members-item"
            }
        }
    }
}

ネストされたスキーマ : メンバー

タイプ: array

タイトル: Members

ロールに割り当てられたユーザーのリストです。

Show Source

Array of: object members-item

{
    "title":"Members",
    "type":"array",
    "description":"A list of users assigned to the role.",
    "items":{
        "$ref":"#/components/schemas/members-item"
    }
}

ネストされたスキーマ : メタ

タイプ: object

タイトル: meta

ロール・リソースのメタデータ。

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

タイプ: array

タイトル: Schemas

ロール・リソースのスキーマ。

Show Source

Array of: string

{
    "title":"Schemas",
    "type":"array",
    "description":"The schema of the roles resource.",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ : members-item

タイプ: object

Show Source

operation: string

タイトル: Operation

PATCHリクエストで実行される操作。
value: string

タイトル: Value

ロールに割り当てられたユーザーの一意の識別子。

{
    "type":"object",
    "properties":{
        "operation":{
            "title":"Operation",
            "type":"string",
            "description":"The operation to be performed in the PATCH request."
        },
        "value":{
            "title":"Value",
            "type":"string",
            "description":"The unique identifier of the user assigned to the role."
        }
    }
}

トップに戻る

例

次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行して、すべてのロールを取得する方法を示します。

curl -i -u "<username>:<password>" -X GET https://servername.fa.us2.oraclecloud.com/hcmRestApi/scim/Roles

レスポンス・ヘッダーの例

次に、レスポンス・ヘッダーの例を示します。

Status: HTTP/1.1 200 OK
Content-Type : application/json

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています:

{
  "itemsPerPage": 500,
  "startIndex": 1,
  "Resources": [
    {
      "id": "6FC956208A6A4E87A1F57E76F08D1616",
      "meta": {
        "created": "2016-09-08 12:05:09.192",
        "lastModified": "2016-10-19 04:58:45.278",
        "location": "http://<host>:<port>/hcmRestApi/scim/Roles/6FC956208A6A4E87A1F57E76F08D1616"
      },
      "schemas": [
        "urn:oracle:apps:scim:schemas:fa:1.0:Role"
      ],
      "name": "DATA_ROLE_TEST_1.1160908_115907_DATA",
      "displayName": "data role test 1.1160908_115907",
      "description": "data role test 1.1160908_115907 Data",
      "category": "DATA",
      "members": [
        {
          "value": "3BBE77DF8A0FF8F2E050F00A081B2E54"
        }
      ]
    },
    {
      "id": "913BCD5BE7C54062A88A14A54E42A7B0",
      "meta": {
        "created": "2016-09-15 13:50:35.809",
        "lastModified": "2016-10-19 04:58:49.097",
        "location": "http://<host>:<port>/hcmRestApi/scim/Roles/913BCD5BE7C54062A88A14A54E42A7B0"
      },
      "schemas": [
        "urn:oracle:apps:scim:schemas:fa:1.0:Role"
      ],
      "name": "DATA_ROLE_TEST_1.1160915_134459_DATA",
      "displayName": "data role test 1.1160915_134459",
      "description": "data role test 1.1160915_134459 Data",
      "category": "DATA",
      "members": [
        {
          "value": "3BBE77930627B046E050F00A081B2DD3"
        }
      ]
    },
 .....
 .....
 ]
}

「トップに戻る」