機械翻訳について
  1. Oracle Fusion Cloud Applications共通機能のためのREST API
  2. タスク
  3. スキーマ

スキーマの取得

get

/hcmRestApi/scim/Schemas/{id}

スキーマの取得

リクエスト

パス・パラメータ

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

トップに戻る

レスポンス

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

デフォルト・レスポンス

次の表に、このタスクのデフォルト・レスポンスを示します。
本文 ()
ルート・スキーマ : Schemas-item
タイプ: object
Show Source
ネストされたスキーマ : 属性
タイプ: array
タイトル: Attributes
スキーマの属性。
Show Source
ネストされたスキーマ : メタ
タイプ: object
タイトル: Meta
スキーマのメタデータ。
ネストされたスキーマ : スキーマ
タイプ: array
タイトル: Schemas
スキーマ・リソースのスキーマ値。
Show Source
ネストされたスキーマ : attributes-item
タイプ: object
Show Source
  • タイトル: CaseExact
    属性名で大/小文字が区別されるかどうかを示します。 デフォルト値はfalseです。
  • タイトル: Description
    属性の説明。
  • タイトル: MultiValued
    属性に複数の値(複数のEメールIDなど)が含まれているかどうかを示します。 デフォルト値はfalseです。
  • タイトル: Mutability
    属性の変更可能性。 デフォルト値はreadWriteです。
  • タイトル: Name
    属性名。
  • タイトル: Required
    属性が必須かどうかを示します。 デフォルト値はfalseです。
  • タイトル: Returned
    問合せにレスポンスして属性値を返すかどうかを指定します。 デフォルト値は、属性値が返されることを示す値です。
  • subAttributes
    タイトル: subAttributes
    属性のサブ属性。
  • タイトル: Type
    属性データ型です。
  • タイトル: Uniqueness
    属性値の一意性を指定します。 値が一意でないことを示すデフォルト値はnoneです。
ネストされたスキーマ : subAttributes
タイプ: array
タイトル: subAttributes
属性のサブ属性。
Show Source
ネストされたスキーマ : subattributes-item
タイプ: object
Show Source
  • タイトル: CaseExact
    サブ属性名で大/小文字が区別されるかどうかを示します。 デフォルト値はfalseです。
  • タイトル: Description
    サブ属性の説明。
  • タイトル: MultiValued
    サブ属性に複数の値が含まれているかどうかを示します。 デフォルト値はfalseです。
  • タイトル: Mutability
    サブ属性の可変性。 デフォルト値はreadWriteです。
  • タイトル: Name
    サブ属性名。
  • タイトル: Required
    サブ属性が必須かどうかを示します。 デフォルト値はfalseです。
  • タイトル: Type
    サブ属性データ型です。
トップに戻る

例

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによってスキーマを取得する方法を示しています。

curl -i -u "<username>:<password>" -X GET https://servername.fa.us2.oraclecloud.com/hcmRestApi/scim/Schema/urn:scim:schemas:core:2.0:User

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

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

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

レスポンス本文の例

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

{
  "id": "urn:scim:schemas:core:2.0:User",
  "meta": {
    "resourceType": "Schema",
    "created": "2010-01-23T04:56:22Z",
    "lastModified": "2014-02-04T00:00:00Z",
    "location": "http://<host>:<port>/hcmRestApi/scim/Schemas/urn:scim:schemas:core:2.0:User",
    "version": "W/\"3694e05e9dff596\""
  },
  "schemas": [
    "urn:scim:schemas:core:2.0:Schema"
  ],
  "name": "User",
  "description": "Fusion Application User ",
  "attributes": [
    {
      "name": "id",
      "type": "String",
      "description": "A unique identifier for the user, which is defined by the web service provider.",
      "mutability": "readOnly",
      "multiValued": false,
      "required": false,
      "caseExact": true
    },
    {
      "name": "externalId",
      "type": "String",
      "description": "An external identifier for the user, which is defined by the web service consumer.",
      "mutability": "readWrite",
      "multiValued": false,
      "required": false,
      "caseExact": true
    },
    {
      "name": "userName",
      "type": "String",
      "description": "A unique identifier for the user that is used to authenticate with the service provider, directly. This attribute is mandatory. ",
      "mutability": "readWrite",
      "multiValued": false,
      "required": true,
      "caseExact": true
    },
    {
      "name": "name",
      "type": "complex",
      "description": "The components of user???s name. This attribute may return: full name as a single string. individual component attributes. both variants. The formatted version indicates how the component attributes are combined so that both variants describe the same name.",
      "mutability": "readWrite",
      "subAttributes": [
        {
          "name": "familyName",
          "type": "String",
          "description": "The last name of the user.",
          "mutability": "readWrite",
          "multiValued": false,
          "required": false,
          "caseExact": true
        },
        {
          "name": "givenName",
          "type": "String",
          "description": "The first name of the user.",
          "mutability": "readWrite",
          "multiValued": false,
          "required": false,
          "caseExact": true
        }
      ],
      "multiValued": false,
      "required": false,
      "caseExact": true
    },
    {
      "name": "displayName",
      "type": "String",
      "description": "The display name of the user, which should include all the available component attributes.",
      "mutability": "readWrite",
      "multiValued": false,
      "required": false,
      "caseExact": true
    },
    {
      "name": "preferredLanguage",
      "type": "String",
      "description": "The preferred language of the user, which is used to select a localized user interface. For example, use en_US to specify English as the language and US as the country. ",
      "mutability": "readWrite",
      "multiValued": false,
      "required": false,
      "caseExact": true
    },
    {
      "name": "active",
      "type": "boolean",
      "description": "Indicates the administrative status of the user. The service provider determines the definitive value for this attribute. If the value is true, then the user is able to login. If the value is false, then the user account is suspended. ",
      "mutability": "readWrite",
      "multiValued": false,
      "required": false,
      "caseExact": true
    },
    {
      "name": "emails",
      "type": "complex",
      "description": "The e-mail addresses of the user. The service provider uses canonical form of these addresses, for example, bjensen@example.com instead of bjensen@EXAMPLE.COM.  ",
      "mutability": "readWrite",
      "subAttributes": [
        {
          "name": "value",
          "type": "string",
          "description": "The e-mail address of the user.",
          "mutability": "readWrite",
          "multiValued": false,
          "required": false,
          "caseExact": true
        },
        {
          "name": "primary",
          "type": "boolean",
          "description": "Indicates that this e-mail id is the primary address. This value is hard coded to true.",
          "mutability": "readOnly",
          "multiValued": false,
          "required": false,
          "caseExact": true
        },
        {
          "name": "type",
          "type": "string",
          "description": "The type of e-mail id, which is hard coded to work.",
          "mutability": "readOnly",
          "multiValued": false,
          "required": false,
          "caseExact": true
        }
      ],
      "multiValued": true,
      "required": false,
      "caseExact": true
    },
    {
      "name": "roles",
      "type": "complex",
      "description": "The list of roles for users in Oracle Applications Cloud.",
      "mutability": "readOnly",
      "subAttributes": [
        {
          "name": "id",
          "type": "string",
          "description": "A list of ids for the roles that a user can belong to, through direct membership.",
          "mutability": "readOnly",
          "multiValued": false,
          "required": false,
          "caseExact": true
        },
        {
          "name": "value",
          "type": "string",
          "description": "A list of values for the roles.",
          "mutability": "readOnly",
          "multiValued": false,
          "required": false,
          "caseExact": true
        },
        {
          "name": "displayName",
          "type": "string",
          "description": "The display name of the role, as used in related screens.",
          "mutability": "readOnly",
          "multiValued": false,
          "required": false,
          "caseExact": true
        },
        {
          "name": "description",
          "type": "string",
          "description": "The description of the role.",
          "mutability": "readOnly",
          "multiValued": false,
          "required": false,
          "caseExact": true
        }
      ],
      "multiValued": true,
      "required": false,
      "caseExact": true
    }
  ]
}
「トップに戻る」