機械翻訳について

ジャンプ先

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

参照キーによるユーザー・グループの取得

get

/km/api/v1/userGroups/referenceKey/{referenceKey}

指定された参照キーを持つユーザー・グループを取得します。

リクエスト

パス・パラメータ

• referenceKey: string
  ユーザー・グループのreferenceKey識別子

トップに戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

「OK」をクリックします。

本文( )

ルート・スキーマ : UserGroup

タイプ: object

タイトル: UserGroup

ソースを表示

• dateAdded(optional): string(date-time)

  UserGroupオブジェクトが作成された日付

• dateModified(optional): string(date-time)

  UserGroupオブジェクトが最後に変更された日付

• description(optional): string
  ユーザー・グループのローカライズされた説明
• externalId(optional): integer

  外部システムからの対応するuserGroupの一意の識別子。 外部IDをExternalTypeパラメータとともに使用して、内部および外部システム内のユーザー・グループを接続できます。

• externalType(optional): string

  ExternalTypeは、外部システムからの対応するuserGroupのタイプです。

• links(optional): array links
• localizedAttributes(optional): array localizedAttributes
  様々なロケールでのこのUserGroupのLocalizedAttributesのリスト
• name(optional): string

  ユーザー・グループのローカライズされた名前。 名前フィールドはソートにのみ使用できます。

• objectId(optional): string

  ユーザー・グループの階層を表す文字列。 すべてのユーザー・グループはTAG表に格納されますが、現在は階層化されていません

• recordId(optional): string

  userGroupsリソースを表すTAG表の一意の識別子

• referenceKey(optional): string

  ユーザー・グループのローカライズされていない名前

• stripeCD(optional): string

  UserGroupのストライプ

{
    "title":"UserGroup",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier from the TAG table that represent a userGroups resource</p>",
            "type":"string"
        },
        "localizedAttributes":{
            "items":{
                "$ref":"#/definitions/LocalizedAttributes"
            },
            "description":"List of LocalizedAttributes of this UserGroup in various Locales",
            "type":"array"
        },
        "externalType":{
            "description":"<p>The ExternalType is the type of the corresponding userGroup from an external system.</p>",
            "type":"string"
        },
        "dateModified":{
            "description":"<p>The date when the UserGroup object was last modified</p>",
            "format":"date-time",
            "type":"string"
        },
        "referenceKey":{
            "description":"<p>The non localized name of the user group</p>",
            "type":"string"
        },
        "objectId":{
            "description":"<p>The string representing the hierarchy of the user groups. All user groups are stored in the TAG table but they are currently not hierarchical</p>",
            "type":"string"
        },
        "description":{
            "description":"The localized description of the user group",
            "type":"string"
        },
        "name":{
            "description":"<p>The localized name of the user group.  The name field can only be used for sorting.</p>",
            "type":"string"
        },
        "dateAdded":{
            "description":"<p>The date when the UserGroup object was created</p>",
            "format":"date-time",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "stripeCD":{
            "description":"<p>Stripe for UserGroup</p>",
            "type":"string"
        },
        "externalId":{
            "description":"<p>The unique identifier of the corresponding userGroup from an external system. You can use the External ID with the ExternalType parameter to connect user groups in the internal and the the external systems.</p>",
            "type":"integer"
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

ソースを表示

• Array of: object instanceLink
  JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

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

タイプ: array

様々なロケールでのこのUserGroupのLocalizedAttributesのリスト

ソースを表示

• Array of: object LocalizedAttributes
  タイトル: LocalizedAttributes

{
    "items":{
        "$ref":"#/definitions/LocalizedAttributes"
    },
    "description":"List of LocalizedAttributes of this UserGroup in various Locales",
    "type":"array"
}

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

タイプ: object

JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

ソースを表示

• href: string
  URI [RFC3986]またはURIテンプレート[RFC6570]。 値がURI Templateに設定されている場合、「templated」プロパティをtrueに設定する必要があります。
• mediaType(optional): string
  RFC 2046で定義された、リンク・ターゲットを説明するメディア・タイプ。
• method(optional): string
  リンクのターゲットをリクエストするためのHTTPメソッド。
• profile(optional): string
  ターゲット・リソースの参照解除時に予期されるリソースを記述する、JSONスキーマなどのリソースのメタデータへのリンク。
• rel: string
  リンクの詳細を取得するためにタイプ・プロパティに加えて使用できるリンク関係の名前。 たとえば、hrefやprofileです。
• templated(optional): boolean
  hrefプロパティがURIまたはURIテンプレートであることを指定するブール・フラグ。 プロパティがURIテンプレートの場合は、この値をtrueに設定します。 デフォルトでは、この値はfalseです。

{
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "templated":{
            "description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.",
            "type":"boolean"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "type":"string"
        },
        "rel":{
            "description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.",
            "type":"string"
        },
        "href":{
            "description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.",
            "type":"string"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "profile":{
            "description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..",
            "type":"string"
        }
    },
    "required":[
        "href",
        "rel"
    ],
    "type":"object"
}

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

タイプ: object

タイトル: LocalizedAttributes

ソースを表示

• description(optional): string
  上のロケールでローカライズされた説明
• localeId(optional): string
  ロケールのRecordId - 通常、これはlocaleCode (en_USなど)であり、実際のGUIDではありません。
• name(optional): string
  上のロケールでローカライズされた名前

{
    "title":"LocalizedAttributes",
    "properties":{
        "localeId":{
            "description":"RecordId of the Locale - generally this is the localeCode (like en_US) and NOT a real GUID.",
            "type":"string"
        },
        "description":{
            "description":"Localized description in the above Locale",
            "type":"string"
        },
        "name":{
            "description":"Localized Name in the above Locale",
            "type":"string"
        }
    }
}

トップに戻る

例

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、指定された参照キーを持つユーザー・グループ・オブジェクトを検索する方法を示しています。

curl -X "GET" "http://IM_REST_API_HOST/km/api/latest/userGroups/referenceKey/{referenceKey}"

リクエスト・ヘッダーの例

次に、リクエスト・ヘッダーの例を示します。

curl -X GET "https://<IM_REST_API_HOST>/km/api/latest/userGroups/referenceKey/{referenceKey}" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json"

レスポンス本文の例

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

{
    "recordId": "8410EB4CB48C5E7CE05323BDF20A8468",
    "referenceKey": "EMPLOYEEHCM",
    "name": "Empleado",
    "links": [
        {
            "rel": "canonical",
            "href": "https://IM_REST_API_HOST>/km/api/v1/userGroups/8410EB4CB48C5E7CE05323BDF20A8468",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        },
        {
            "rel": "collection",
            "href": "https://IM_REST_API_HOST>/km/api/v1/userGroups",
            "mediaType": "application/json, application/xml",
            "method": "GET",
            "profile": "https://IM_REST_API_HOST>/km/api/v1/metadata-catalog/userGroups"
        }
    ],
    "dateAdded": "1970-01-01T23:11:11+0000",
    "dateModified": "1970-01-01T23:11:11+0000",
    "objectId": "-3",
    "description": "Grupo de usuarios EMPLOYEE para el departamento HCM",
    "localizedAttributes": [
        {
        
        {
            "localeId": "da_DK",
            "name": "Medarbejder",
            "description": "EMPLOYEE brugergruppe til HCM-afdelingen"
        },
        {
            "localeId": "en_AU",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "en_CA",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "en_GB",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "en_HK",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "en_ID",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "en_IE",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "en_IL",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "en_IN",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "en_IS",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "en_NZ",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "en_SG",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "en_US",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "en_ZA",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "es_AR",
            "name": "Empleado",
            "description": "Grupo de usuarios EMPLOYEE para el departamento HCM"
        }
        
            ],
    "stripeCd": "ORA_SVC_HCM"
}

「トップに戻る」