ユーザー・グループの更新
/km/api/v1/userGroups/{id}
指定されたIDでユーザー・グループを更新します。
リクエスト
- application/json
- application/xml
- id: string
更新するオブジェクトの一意の識別子。
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のストライプ
array
- Array of: object instanceLink
JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。
array
- Array of: object LocalizedAttributes
タイトル:
LocalizedAttributes
object
- 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です。
object
LocalizedAttributes
- description(optional): string
上のロケールでローカライズされた説明
- localeId(optional): string
ロケールのRecordId - 通常、これはlocaleCode (en_USなど)であり、実際のGUIDではありません。
- name(optional): string
上のロケールでローカライズされた名前
レスポンス
- application/json
- application/xml
200 レスポンス
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のストライプ
array
- Array of: object instanceLink
JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。
array
- Array of: object LocalizedAttributes
タイトル:
LocalizedAttributes
object
- 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です。
object
LocalizedAttributes
- description(optional): string
上のロケールでローカライズされた説明
- localeId(optional): string
ロケールのRecordId - 通常、これはlocaleCode (en_USなど)であり、実際のGUIDではありません。
- name(optional): string
上のロケールでローカライズされた名前
例
次の例は、cURLを使用してRESTリソースに対するポスト・リクエストを発行することによって、指定したユーザーIDのユーザー・グループ・オブジェクトを更新する方法を示しています。
curl -X PUT "https://<IM_REST_API_HOST>/km/api/latest/userGroups/{id}" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json" -d "@<FilePath/RequestBody.json>"
リクエスト本文の例
次の例は、JSON形式のリクエスト本文のコンテンツを示しています:
{ "recordId": "5D08D6C6E47E4B309D4651EAB11A5224", "referenceKey": "PAYROLL", "name": "Payroll Agents", "dateAdded": "2019-09-23T20:32:19+0000", "dateModified": "2019-09-23T20:32:19+0000", "objectId": "030", "stripeCd": "ORA_SVC_HCM", "description": "Payroll Agent User Group updated using the REST API", "localizedAttributes": [ { "localeId": "en_US", "name": "Payroll Agents" }, { "localeId": "ar_AE", "name": "<name in Arabic>" }, { "localeId": "de_DE", "name": "Gehaltsabrechnungsagenten" }, { "localeId": "es_ES", "name": "<name in Spanish>" }, { "localeId": "fr_FR", "name": "agents de paie" }, { "localeId": "ja_JP", "name": "<name in Japanese>" }, { "localeId": "ko_KR", "name": "<name in Korean>" }, { "localeId": "sv_SE", "name": "<name in Swedish>" }, { "localeId": "zh_CN", "name": "<name in Chinese>" } ] }
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています:
{ "recordId": "7E664B42F8F14A90AB68EF55C1A3AEB9", "referenceKey": "PAYROLL", "name": "Payroll Agents", "links": [ { "rel": "canonical", "href": "https://<IM_REST_API_HOST>/km/api/latest/userGroups/7E664B42F8F14A90AB68EF55C1A3AEB9", "mediaType": "application/json, application/xml", "method": "GET" }, { "rel": "collection", "href": "https://<IM_REST_API_HOST>/km/api/latest/userGroups", "mediaType": "application/json, application/xml", "method": "GET", "profile": "https://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/userGroups" } ], "dateAdded": "2019-09-23T19:47:09+0000", "dateModified": "2019-09-23T19:47:09+0000", "objectId": "030", "description": "Payroll Agent User Group created using the REST API", "localizedAttributes": [ { "localeId": "en_US", "name": "Payroll Agents", "description": "Payroll Agent User Group updated using the REST API" }, { "localeId": "ar_AE", "name": "<name in Arabic>" }, { "localeId": "de_DE", "name": "Gehaltsabrechnungsagenten" }, { "localeId": "es_ES", "name": "<name in Spanish>" }, { "localeId": "fr_FR", "name": "agents de paie" }, { "localeId": "ja_JP", "name": "<name in Japanese>" }, { "localeId": "ko_KR", "name": "<name in Korean>" }, { "localeId": "sv_SE", "name": "<name in Swedish>" }, { "localeId": "zh_CN", "name": "<name in Chinese>" } ], "stripeCd": "ORA_SVC_HCM" }