すべてのスキーマの取得
get
/hcmRestApi/scim/Schemas
すべてのスキーマの取得
リクエスト
この操作のリクエスト・パラメータはありません。
この操作にはリクエスト本文がありません。
トップに戻るレスポンス
サポートされているメディア・タイプ
- application/json
デフォルト・レスポンス
次の表に、このタスクのデフォルト・レスポンスを示します。
ルート・スキーマ : スキーマ
タイプ:
Show Source
object-
itemsPerPage: integer
タイトル:
ItemsPerPage現在の範囲内で返されるリソース・インスタンス数。 -
Resources: array Resources
タイトル:
Resourcesコレクション内のスキーマ。 -
startIndex: integer
タイトル:
start indexリソース・コレクションの開始位置。 たとえば、startIndexが11でitemsPerPageが10の場合、レスポンス本文には11から20までの行が含まれます。
ネストされたスキーマ : Schemas-item
タイプ:
Show Source
object-
attributes: array Attributes
タイトル:
Attributesスキーマの属性。 -
description: string
タイトル:
Descriptionスキーマの説明です。 -
id: string
タイトル:
IdOracle Applications Cloudのスキーマの一意の識別子。 -
meta: object Meta
タイトル:
Metaスキーマのメタデータ。 -
name: string
タイトル:
Nameスキーマの名前。 -
schemas: array Schemas
タイトル:
Schemasスキーマ・リソースのスキーマ値。
ネストされたスキーマ : メタ
タイプ:
objectタイトル:
Metaスキーマのメタデータ。
ネストされたスキーマ : attributes-item
タイプ:
Show Source
object-
caseExact: boolean
タイトル:
CaseExact属性名で大/小文字が区別されるかどうかを示します。 デフォルト値はfalseです。 -
description: string
タイトル:
Description属性の説明。 -
multiValued: boolean
タイトル:
MultiValued属性に複数の値(複数のEメールIDなど)が含まれているかどうかを示します。 デフォルト値はfalseです。 -
mutability: string
タイトル:
Mutability属性の変更可能性。 デフォルト値はreadWriteです。 -
name: string
タイトル:
Name属性名。 -
required: boolean
タイトル:
Required属性が必須かどうかを示します。 デフォルト値はfalseです。 -
returned: string
タイトル:
Returned問合せにレスポンスして属性値を返すかどうかを指定します。 デフォルト値は、属性値が返されることを示す値です。 -
subAttributes: array subAttributes
タイトル:
subAttributes属性のサブ属性。 -
type: string
タイトル:
Type属性データ型です。 -
uniqueness: string
タイトル:
Uniqueness属性値の一意性を指定します。 値が一意でないことを示すデフォルト値はnoneです。
ネストされたスキーマ : subattributes-item
タイプ:
Show Source
object-
caseExact: boolean
タイトル:
CaseExactサブ属性名で大/小文字が区別されるかどうかを示します。 デフォルト値はfalseです。 -
description: string
タイトル:
Descriptionサブ属性の説明。 -
multiValued: boolean
タイトル:
MultiValuedサブ属性に複数の値が含まれているかどうかを示します。 デフォルト値はfalseです。 -
mutability: string
タイトル:
Mutabilityサブ属性の可変性。 デフォルト値はreadWriteです。 -
name: string
タイトル:
Nameサブ属性名。 -
required: boolean
タイトル:
Requiredサブ属性が必須かどうかを示します。 デフォルト値はfalseです。 -
type: string
タイトル:
Typeサブ属性データ型です。
例
次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべてのスキーマを取得する方法を示しています。
curl -i -u "<username>:<password>" -X GET https://servername.fa.us2.oraclecloud.com/hcmRestApi/scim/Schemas
レスポンス・ヘッダーの例
次に、レスポンス・ヘッダーの例を示します。
Status: HTTP/1.1 200 OK Content-Type : application/json
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています:
{
"itemsPerPage": 3,
"startIndex": 1,
"Resources": [
{
"id": "urn:oracle:apps:scim:schemas:fa:1.0:UserRequest",
"meta": {
"resourceType": "Schema",
"created": "2010-01-23T04:56:22Z",
"lastModified": "2014-02-04T00:00:00Z",
"location": "http://<host>:<port>/hcmRestApi/scim/Schemas/urn:oracle:apps:scim:schemas:fa:1.0:UserRequest",
"version": "W/\"3694e05e9dff596\""
},
D56D17 "schemas": [
"urn:scim:schemas:core:2.0:Schema"
],
"name": "UserRequest",
"description": "Fusion Application User Requests",
"attributes": [
{
"name": "userRequestType",
"type": "String",
"description": "The action code of the user request to create, update, or delete. ",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": false
},
{
"name": "addresses",
"type": "complex",
"description": "The address information of the user.",
"mutability": "readOnly",
"subAttributes": [
{
"name": "country",
"type": "string",
"description": "The county name in the address.",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": false
},
{
"name": "locality",
"type": "string",
"description": "The locality name in the address.",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": false
},
{
"name": "formatted",
"type": "string",
"description": "The formatted version of the address.",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": false
},
{
"name": "region",
"type": "string",
"description": "The region details in the address.",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": false
},
{
"name": "streetAddress",
"type": "string",
"description": "The street name or number in the address.",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": false
},
{
"name": "postalCode",
"type": "string",
"description": "The postal code of the address.",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": false
}
],
"multiValued": true,
"required": false,
"caseExact": true
},
{
"name": "employeeNumber",
"type": "String",
"description": "A unique employee number for the user???s account in Oracle Applications Cloud.",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": false
},
{
"name": "manager",
"type": "complex",
"description": "The details of the user???s manager.",
"mutability": "readOnly",
"subAttributes": [
{
"name": "managerId",
"type": "string",
"description": "The unique identifier of the user???s manager.",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": false
},
{
"name": "$ref",
"type": "string",
"description": "The URI reference of the user???s manager.",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": false
},
{
"name": "displayName",
"type": "string",
"description": "The display name of the user???s manager.",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": false
},
{
"name": "userName",
"type": "string",
"description": "User Name of the Manager",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": false
}
],
"multiValued": false,
"required": false,
"caseExact": false
},
{
"name": "phoneNumbers",
"type": "complex",
"description": "The user???s phone number information.",
"mutability": "readOnly",
"subAttributes": [
{
"name": "value",
"type": "string",
"description": "The phone number of the user.",
"mutability": "readOnly",
"required": false,
"caseExact": false
},
{
"name": "type",
"type": "string",
"description": "The type of phone number.",
"mutability": "readOnly",
"required": false,
"caseExact": false
}
],
"multiValued": true,
"required": false,
"caseExact": false
},
{
"name": "userType",
"type": "String",
"description": "User???s type that is used to identify the organization to user relationship such as Contractor, Employee, Intern, Temp, External, and Unknown.",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": false
},
{
"name": "user",
"type": "complex",
"description": "The user information in Oracle Applications Cloud.",
"mutability": "readOnly",
"subAttributes": [
{
"name": "id",
"type": "String",
"description": "Id for user scim resource within FA",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": false
},
{
"name": "externalId",
"type": "String",
"description": "External Id for the user resource",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": false
},
{
"name": "active",
"type": "boolean",
"description": "Indicates the account status of the user in Oracle Applications Cloud. ",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": true
},
{
"name": "displayName",
"type": "String",
"description": "The display name of the user account. ",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": false
},
{
"name": "emails",
"type": "complex",
"description": "The e-mail information of the user.",D1
"mutability": "readOnly",D9
"subAttributes": [
{
"name": "value",
"type": "string",
"description": "The e-mail address of the user.",
"mutability": "readOnly",
"required": false,
"caseExact": false
},
{
"name": "primary",
"type": "boolean",
"description": "Indicates if this value is the primary address for the user.",
"mutability": "readOnly",
"required": false,
"caseExact": false
},
{
"name": "type",
"type": "string",
"description": "The type of e-mail address. Valid values are work, home, and other.",
"mutability": "readOnly",
"required": false,
"caseExact": false
}
],
"multiValued": true,
"required": false,
"caseExact": true
},
{
"name": "name",
"type": "complex",
"description": "The name of the user.",
"mutability": "readOnly",
"subAttributes": [
{
"name": "honorificSuffix",
"type": "string",
"description": "The honorific suffix to be used with the user???s name.",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": false
},
{
"name": "honorificPrefix",
"type": "string",
"description": "The honorific prefix to be used with the user???s name.",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": false
},
{
"name": "givenName",
"type": "string",
"description": "The first name of the user.",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": false
},
{
"name": "initials",
"type": "string",
"description": "The initials in the user???s name.",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": false
},
{
"name": "familyName",
"type": "string",
"description": "The last name of the user.",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": false
},
{
"name": "formatted",
"type": "string",
"description": "The formatted version of the name that indicates how the attributes of the name are combined.",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": false
},
{
"name": "middleName",
"type": "string",
"description": "The middle name of the user.",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": false
}
],
"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.",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": true
},
{
"name": "userName",
"type": "String",
"description": "User Name",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": true
}
],
"multiValued": false,
"required": false,
"caseExact": true
}
]
},
{
"id": "urn:oracle:apps:scim:schemas:fa:1.0:Role",
"meta": {
"resourceType": "Schema",
"created": "2010-01-23T04:56:22Z",
"lastModified": "2014-02-04T00:00:00Z",
"location": "http://<host>:<port>/hcmRestApi/scim/Schemas/urn:oracle:apps:scim:schemas:fa:1.0:Role",
"version": "W/\"3694e05e9dff596\""
},
"schemas": [
"urn:scim:schemas:core:2.0:Schema"
],
"name": "Roles",
"description": "Oracle Fusion Application Roles",
"attributes": [
{
"name": "name",
"type": "string",
"description": "The name of the role in Oracle Applications",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": true
},
{
"name": "displayName",
"type": "string",
"description": "The display name for the role in Oracle Applications Cloud",
"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
},
{
"name": "category",
"type": "string",
"description": "The category of the role",
"mutability": "readOnly",
"multiValued": false,
"required": false,
"caseExact": true
},
{
"name": "members",
"type": "complex",
"description": "A list of users assigned to the role.",
"mutability": "readWrite",
"subAttributes": [
{
"name": "operation",
"type": "string",
"description": "operation to be performed on PATCH operation",
"mutability": "readWrite",
"required": false,
"caseExact": true
},
{
"name": "value",
"type": "string",
"description": "The unique identifier of the user assigned to the role.",
"mutability": "readWrite",
"required": false,
"caseExact": true
}
],
"multiValued": true,
"required": false,
"caseExact": true
}
]
},
{
"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
}
]
}
]
}