リソース・ユーザーの更新
/crmRestApi/resources/11.13.18.05/resourceUsers/{resourceUsersUniqID}
リクエスト
- resourceUsersUniqID(required): string
これは、リソース・ユーザー・リソースのコンポジット・キーを構成し、リソース・ユーザーのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、ハッシュ・キーを取得するためにリソース・ユーザーの特定のインスタンスに移動するために、リソース・ユーザー・コレクション・リソースを問い合せる必要があります。
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
- application/json
object-
AddressLine1: string
タイトル:
Address Line 1最大長:240リソースのアドレスの最初の行。 -
AddressLine2: string
タイトル:
Address Line 2最大長:240リソースのアドレスの2行目。 -
County: string
タイトル:
County最大長:60リソースのアドレスに指定されている郡の名前。 -
CreateUserAccountFlag: boolean
タイトル:
Create User Accountリソースのユーザー・アカウントを作成できるかどうかを示します。 デフォルト値はtrueです。 -
FaxCountryCode: string
タイトル:
Phone Country Code最大長:10FAXの国コード。 -
FirstName: string
タイトル:
First Name最大長:150リソースの名。 -
HRManagerEmailAddress: string
タイトル:
HR Manager Emailリソースの人事管理マネージャのEメール・アドレス。 -
IndividualRoleCode: string
タイトル:
Individual Role Code最大長:255ユーザーの特別個人ロール。 -
IndividualRoleEndDate: 文字列(日付)
タイトル:
Individual Role End Date個々のロールが終了する日付。 -
IndividualRoleStartDate: 文字列(日付)
タイトル:
Individual Role Start Date個々のロールが開始する日付。 -
JobCode: string
タイトル:
Job Codeリソースに割り当てられたジョブ・コード。 -
LastName: string
タイトル:
Last Name最大長:150リソースの姓。 -
MiddleName: string
タイトル:
Middle Name最大長:60リソースのミドル・ネーム。 -
MobilePhoneCountryCode: string
タイトル:
Phone Country Code最大長:10携帯電話に関連付けられている国コード。 -
PersonType: string
タイトル:
Person Typeリソースに関連付けられている就業者の雇用関係のタイプ。 退職者、従業員、派遣または就業者。 -
Province: string
タイトル:
Province最大長:60リソースのアドレスに指定された州の名前。 -
RawFaxNumber: string
タイトル:
Fax最大長:60RAW形式のリソースのFAX番号。 -
RawMobilePhoneNumber: string
タイトル:
Mobile Phone最大長:60リソースの携帯電話番号。 -
RawWorkPhoneNumber: string
タイトル:
Work Phone最大長:60未処理書式のリソース勤務先電話番号。 -
ResourceEmail: string
タイトル:
Email最大長:320リソースの電子メール・アドレス。 -
ResourceEndDate: 文字列(日付)
タイトル:
To Dateリソースがアクティブになるまでの日付。 -
ResourceManagerFirstName: string
タイトル:
Manager First Name最大長:255リソースのレポート・マネージャの名。 -
ResourceManagerLastName: string
タイトル:
Manager Last Name最大長:255リソースのレポート・マネージャの姓。 -
ResourceManagerName: string
タイトル:
Manager Name最大長:255リソースのマネージャの名前。 -
ResourceOrganizationName: string
タイトル:
Organization最大長:255管理ロールのリソースに関連付けられているリソース組織の名前。 -
ResourceOrgManagerEmail: string
タイトル:
Manager Email最大長:255リソースのレポート・マネージャのEメール・アドレス。 -
ResourceOrgMemRoleEndDate: 文字列(日付)
タイトル:
Membership Role End Dateリソースのメンバーシップが終了する日付。 -
ResourceOrgMemRoleStartDate: 文字列(日付)
タイトル:
Organization Membership Role Start Dateリソースが組織のメンバーになる日付。 -
ResourceOrgRoleCode: string
タイトル:
Organization Role Code最大長:255組織メンバーシップに関連するリソースのロールを示すコード。 たとえば、SALES_REPRESENTATIVEまたはSALES_MANAGERです。 -
ResourceParentOrganizationName: string
タイトル:
Parent Organization最大長:255リソースのマネージャが関連付けられている組織の名前。 -
ResourcePartyNumber: string
タイトル:
Party Number最大長:30リソースに関連付けられたパーティの一意の識別子。 -
ResourceRoleAssign: array Resource Role Assignments
タイトル:
Resource Role Assignmentsリソース・ロール割当リソースは、リソースに割り当てられたロール(実装者、再販業者など)を表示するために使用されます。 -
ResourceStartDate: 文字列(日付)
タイトル:
Resource Start Dateリソースがアクティブになる日付。 -
ResourceType: string
タイトル:
Usageリソースのタイプ。 -
State: string
タイトル:
State最大長:60リソースのアドレスに指定された状態の名前。 -
TimezoneCode: string
タイトル:
Time Zone Code最大長:64リソースのタイム・ゾーンのコード。 -
Title: string
タイトル:
Title最大長:60リソース名の前のタイトル。 -
TopResourceFlag: boolean
タイトル:
Root Resourceデフォルト値:falseリソースが階層の最上位ユーザーかどうかを示します。 -
UserStatus: string
タイトル:
User Account Status最大長:255リソースのユーザー・アカウントのステータスを示します。 サポートされる値は、アクティブの場合はA、一時停止の場合はSです。 新規アカウントのステータスはAに設定されます。 -
WorkPhoneCountryCode: string
タイトル:
Phone Country Code最大長:10勤務先電話番号に関連付けられた国コード。
arrayResource Role Assignmentsobject-
EndDateActive: 文字列(日付)
タイトル:
To Dateリソース・ロールが非アクティブになる日付。
応答
- application/json
デフォルトのレスポンス
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
object-
AddressLine1: string
タイトル:
Address Line 1最大長:240リソースのアドレスの最初の行。 -
AddressLine2: string
タイトル:
Address Line 2最大長:240リソースのアドレスの2行目。 -
BusinessUnit: string
タイトル:
Business Unitリソースに関連付けられているビジネス・ユニットの名前。 -
City: string
タイトル:
City読取り専用:true最大長:60リソースの住所に指定された市区町村の名前。 -
Country: string
タイトル:
Country読取り専用:true最大長:2リソースの住所に指定された国名。 -
County: string
タイトル:
County最大長:60リソースのアドレスに指定されている郡の名前。 -
CreatedBy: string
タイトル:
Created By読取り専用:true最大長:64レコードを作成したユーザー。 -
CreateUserAccountFlag: boolean
タイトル:
Create User Accountリソースのユーザー・アカウントを作成できるかどうかを示します。 デフォルト値はtrueです。 -
CreationDate: string (date-time)
タイトル:
Creation Date読取り専用:trueレコードが作成された日時。 -
DeleteFlag: boolean
読取り専用:
trueユーザーがリソースを削除できるかどうかを示します。 -
FaxCountryCode: string
タイトル:
Phone Country Code最大長:10FAXの国コード。 -
FirstName: string
タイトル:
First Name最大長:150リソースの名。 -
FormattedAddress: string
読取り専用:
true最大長:255リソースのプライマリ形式のアドレス。 -
HireDate: 文字列(日付)
タイトル:
Hire Dateリソースが採用された日付。 -
HRManagerEmailAddress: string
タイトル:
HR Manager Emailリソースの人事管理マネージャのEメール・アドレス。 -
IndividualRoleCode: string
タイトル:
Individual Role Code最大長:255ユーザーの特別個人ロール。 -
IndividualRoleEndDate: 文字列(日付)
タイトル:
Individual Role End Date個々のロールが終了する日付。 -
IndividualRoleStartDate: 文字列(日付)
タイトル:
Individual Role Start Date個々のロールが開始する日付。 -
JobCode: string
タイトル:
Job Codeリソースに割り当てられたジョブ・コード。 -
JobTitle: string
タイトル:
Job Title読取り専用:trueリソースに割り当てられたジョブのタイトル。 -
LastName: string
タイトル:
Last Name最大長:150リソースの姓。 -
LastUpdateDate: string (date-time)
タイトル:
Last Update Date読取り専用:trueレコードが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By読取り専用:true最大長:64レコードを最後に更新したユーザー。 -
LegalEntity: string
タイトル:
Legal Entityリソースに関連付けられている法的エンティティの名前。 -
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
MiddleName: string
タイトル:
Middle Name最大長:60リソースのミドル・ネーム。 -
MobilePhoneCountryCode: string
タイトル:
Phone Country Code最大長:10携帯電話に関連付けられている国コード。 -
PartyName: string
タイトル:
Resource Name読取り専用:true最大長:360個人の名前。 -
PersonNumber: string
タイトル:
Person Number読取り専用:trueリソースの就業者レコードの個人番号識別子。 -
PersonType: string
タイトル:
Person Typeリソースに関連付けられている就業者の雇用関係のタイプ。 退職者、従業員、派遣または就業者。 -
PostalCode: string
タイトル:
Postal Code読取り専用:true最大長:60リソースの住所の郵便番号。 -
Province: string
タイトル:
Province最大長:60リソースのアドレスに指定された州の名前。 -
RawFaxNumber: string
タイトル:
Fax最大長:60RAW形式のリソースのFAX番号。 -
RawMobilePhoneNumber: string
タイトル:
Mobile Phone最大長:60リソースの携帯電話番号。 -
RawWorkPhoneNumber: string
タイトル:
Work Phone最大長:60未処理書式のリソース勤務先電話番号。 -
ResourceEmail: string
タイトル:
Email最大長:320リソースの電子メール・アドレス。 -
ResourceEndDate: 文字列(日付)
タイトル:
To Dateリソースがアクティブになるまでの日付。 -
ResourceManagerFirstName: string
タイトル:
Manager First Name最大長:255リソースのレポート・マネージャの名。 -
ResourceManagerLastName: string
タイトル:
Manager Last Name最大長:255リソースのレポート・マネージャの姓。 -
ResourceManagerName: string
タイトル:
Manager Name最大長:255リソースのマネージャの名前。 -
ResourceManagerPartyId: integer
タイトル:
Manager Party ID読取り専用:trueリソースのレポート・マネージャの一意の識別子。 -
ResourceManagerPartyNumber: string
タイトル:
Manager Party Number読取り専用:true最大長:255リソースのレポート・マネージャの一意の公開識別子。 -
ResourceOrganizationName: string
タイトル:
Organization最大長:255管理ロールのリソースに関連付けられているリソース組織の名前。 -
ResourceOrganizationUsage: string
タイトル:
Organization Usage読取り専用:true最大長:255リソース組織の使用タイプ。 たとえば、営業やマーケティングなどです。 -
ResourceOrgManagerEmail: string
タイトル:
Manager Email最大長:255リソースのレポート・マネージャのEメール・アドレス。 -
ResourceOrgMemRoleEndDate: 文字列(日付)
タイトル:
Membership Role End Dateリソースのメンバーシップが終了する日付。 -
ResourceOrgMemRoleStartDate: 文字列(日付)
タイトル:
Organization Membership Role Start Dateリソースが組織のメンバーになる日付。 -
ResourceOrgRoleCode: string
タイトル:
Organization Role Code最大長:255組織メンバーシップに関連するリソースのロールを示すコード。 たとえば、SALES_REPRESENTATIVEまたはSALES_MANAGERです。 -
ResourceOrgRoleName: string
読取り専用:
true最大長:255組織または階層内のリソースの機能を定義するロール。 -
ResourceParentOrganizationName: string
タイトル:
Parent Organization最大長:255リソースのマネージャが関連付けられている組織の名前。 -
ResourcePartyId: integer (int64)
タイトル:
Party IDリソースに関連付けられたパーティの一意の識別子。 -
ResourcePartyNumber: string
タイトル:
Party Number最大長:30リソースに関連付けられたパーティの一意の識別子。 -
ResourceProfileId: integer (int64)
タイトル:
Profile ID読取り専用:trueリソースのプロファイルの一意の識別子。 -
ResourceRoleAssign: array Resource Role Assignments
タイトル:
Resource Role Assignmentsリソース・ロール割当リソースは、リソースに割り当てられたロール(実装者、再販業者など)を表示するために使用されます。 -
ResourceStartDate: 文字列(日付)
タイトル:
Resource Start Dateリソースがアクティブになる日付。 -
ResourceType: string
タイトル:
Usageリソースのタイプ。 -
State: string
タイトル:
State最大長:60リソースのアドレスに指定された状態の名前。 -
TimezoneCode: string
タイトル:
Time Zone Code最大長:64リソースのタイム・ゾーンのコード。 -
Title: string
タイトル:
Title最大長:60リソース名の前のタイトル。 -
TopResourceFlag: boolean
タイトル:
Root Resourceデフォルト値:falseリソースが階層の最上位ユーザーかどうかを示します。 -
UpdateFlag: boolean
タイトル:
Update Access読取り専用:trueユーザーがリソースを更新できるかどうかを示します。 -
Username: string
タイトル:
User Name読取り専用:trueリソース・ユーザーのログインに使用されるユーザー名またはアカウント名。 -
UserStatus: string
タイトル:
User Account Status最大長:255リソースのユーザー・アカウントのステータスを示します。 サポートされる値は、アクティブの場合はA、一時停止の場合はSです。 新規アカウントのステータスはAに設定されます。 -
WorkPhoneCountryCode: string
タイトル:
Phone Country Code最大長:10勤務先電話番号に関連付けられた国コード。
arrayResource Role Assignmentsobject-
href: string
タイトル:
hyperlink reference関連リソースへのURI。 -
kind: string
タイトル:
kind許可された値:[ "collection", "item", "describe", "other" ]関連リソースの種類。 -
name: string
タイトル:
name関連リソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]リソース・インスタンスとの関係の名前。 例: self.
object-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
object-
EndDateActive: 文字列(日付)
タイトル:
To Dateリソース・ロールが非アクティブになる日付。 -
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
PartyName: string
タイトル:
Resource最大長:360パーティの名前。 -
RoleCode: string
読取り専用:
true最大長:30リソースに割り当てられたロールのコードの値。 -
RoleId: integer
タイトル:
Roleロールの一意の識別子。 -
RoleRelateId: integer
読取り専用:
trueロール関係識別子(PK) -
RoleResourceId: integer
リソース・ロールの一意の識別子。
-
StartDateActive: 文字列(日付)
タイトル:
From Dateリソース・ロールがアクティブになる日付。
- FaxCountryCodeVA
-
LOVリンク関連では、次のプロパティが定義されます:
- ソース属性: FaxCountryCode;ターゲット属性: PhoneCountryCode
- 表示属性: PhoneCountryCode, TerritoryShortName
- MobilePhoneCountryCodeVA
-
LOVリンク関連では、次のプロパティが定義されます:
- ソース属性: MobilePhoneCountryCode;ターゲット属性: PhoneCountryCode
- 表示属性: PhoneCountryCode, TerritoryShortName
- ResourceRoleAssign
-
パラメータ:
- resourceUsersUniqID:
$request.path.resourceUsersUniqID
リソース・ロール割当リソースは、リソースに割り当てられたロール(実装者、再販業者など)を表示するために使用されます。 - resourceUsersUniqID:
- WorkPhoneCountryCodeVA
-
LOVリンク関連では、次のプロパティが定義されます:
- ソース属性: WorkPhoneCountryCode;ターゲット属性: PhoneCountryCode
- 表示属性: PhoneCountryCode, TerritoryShortName
例:
ノート:
開始日が指定されていないリソースにロールを追加すると、開始日はリソースの採用日に設定されます。
cURLコマンド
curl --user sales_cloud_user -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resourceUsers/CDRM_885912
リクエスト本文の例
次の例は、JSON形式のリクエスト本文のコンテンツを示しています。
{
{
"FirstName": "ABCDE_updated"
}
レスポンス本文の例
次に、JSON形式のレスポンス本文の内容を示します。
{
"ResourceProfileId": 300100185303175,
"PartyName": "ABCDE_updated 20200717_1706",
"LastUpdateDate": "2020-07-20T07:31:46.594+00:00",
"LastUpdatedBy": "sales_admin",
"CreationDate": "2020-07-20T07:31:27.001+00:00",
"CreatedBy": "sales_admin",
"ResourceType": "INDIVIDUAL",
"FormattedAddress": null,
"TimezoneCode": null,
"Username": "ABC_20200717_1706@oracle.com",
"City": null,
"Country": null,
"PostalCode": null,
"UpdateFlag": "true",
"DeleteFlag": "false",
"ResourceOrgRoleCode": null,
"ResourceOrgRoleName": null,
"FirstName": "ABCDE_updated",
"LastName": "20200717_1706",
"MiddleName": null,
"Title": "MR.",
"ResourcePartyNumber": "CDRM_885912",
"State": null,
"ResourceEmail": "ABC_20200717_1706@oracle.com",
"WorkPhoneCountryCode": null,
"RawWorkPhoneNumber": null,
"MobilePhoneCountryCode": null,
"RawMobilePhoneNumber": null,
"FaxCountryCode": null,
"RawFaxNumber": null,
"AddressLine1": null,
"AddressLine2": null,
"ResourceStartDate": "2007-05-01",
"ResourceEndDate": "4712-12-31",
"ResourcePartyId": 300100185303176,
"ResourceOrganizationName": null,
"ResourceOrganizationUsage": null,
"ResourceOrgMemRoleEndDate": null,
"ResourceParentOrganizationName": null,
"ResourceOrgManagerEmail": null,
"ResourceManagerName": null,
"ResourceManagerFirstName": null,
"ResourceManagerLastName": null,
"HRManagerEmailAddress": null,
"HireDate": "2007-05-01",
"ResourceOrgMemRoleStartDate": null,
"IndividualRoleCode": "SALES_MANAGER",
"IndividualRoleStartDate": "2007-05-01",
"IndividualRoleEndDate": "4712-12-31",
"ResourceManagerPartyNumber": null,
"County": null,
"Province": null,
"ResourceManagerPartyId": null,
"TopResourceFlag": null,
"PersonNumber": "300100185303181",
"BusinessUnit": "Vision Corporation Enterprise",
"LegalEntity": "Vision Corporation",
"JobCode": null,
"JobTitle": null,
"UserStatus": "A",
"PersonType": "EMP",
"CreateUserAccountFlag": null,
"__ORACO__DistributionCentre_Id_c": null,
"__ORACO__DistributionCentre_c": null,
"__ORACO__Segment_c": null,
...
}
ノート:
新しいリソース・ユーザーを作成すると、CreateUserAccountFlagによってリソースのユーザー・アカウントの作成が制御されます。 CreateUserAccountFlagのデフォルト値はYです。 フラグがNに設定されている場合、ロール・プロビジョニングは抑制されます。ノート:
UserStatusはデフォルトでAです。 ユーザーを一時停止するには、PATCHを使用してUserStatusをSに更新します。内部リソースの促進または後退
次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行することによって、内部リソースをプロモートまたはデモートする方法を示しています。 そのような例については、「営業リソース・ライフサイクルの管理」を参照してください。
cURLコマンド
curl --user sales_cloud_user -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.19.01/resourceUsers/Conta504976
リクエスト本文の例
次に、JSON形式のリクエスト本文の内容を示します。
{
"ResourceOrgRoleCode":"SALES_VP"
}
レスポンス本文の例
次に、JSON形式のレスポンス本文の内容を示します。
{
"PartyName": "John Smith",
"ResourceType": "INDIVIDUAL",
"FormattedAddress": "500 Oracle Parkway,REDWOOD CITY, CA 944065",
"Username": "jsmith439906587",
"City": "Redwood City",
"Country": "US",
"PostalCode": "944065",
"FirstName": "John",
"LastName": "Smith",
"ResourcePartyNumber": "Conta504976",
"State": "CA",
"ResourceEmail": "john.smith@dnd.vision.com",
"RawWorkPhoneNumber": "6505061212",
"RawMobilePhoneNumber": null,
"RawFaxNumber": null,
"AddressLine1": "500 Oracle Parkway",
"ResourceOrganizationName": "JSmithOrg",
"ResourceOrganizationUsage": "SALES_RESOURCE_ORG",
"ResourceOrgMemRoleEndDate": "4712-12-31",
"ResourceOrgRoleCode":"SALES_VP",
"ResourceParentOrganizationName" : "NA Sales",
"ResourceManagerFirstName": "Phil",
"ResourceManagerLastName": "Gioco",
"HRManagerEmailAddress": "hrMan247134917@vision.com",
"HireDate": "2018-08-20",
"ResourceOrgMemRoleStartDate": "2018-08-20",
"ResourceManagerPartyNumber": "100010034246635",
"ResourceManagerPartyId": 100010034246635,
"PersonNumber": "300100159661235",
"BusinessUnit": "Vision Corporation Enterprise",
"LegalEntity": "Vision Corporation",
"UserStatus": "A",
"PersonType": "EMP",
"CreateUserAccountFlag": null,
...
}
内部リソースの促進または後退
次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行することによって、内部リソースをプロモートまたはデモートする方法を示しています。
cURLコマンド
curl --user sales_cloud_user -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.19.01/resourceUsers/Conta504976
リクエスト本文の例
次に、JSON形式のリクエスト本文の内容を示します。
{
"ResourceOrgRoleCode":"SALES_VP"
}
レスポンス本文の例
次に、JSON形式のレスポンス本文の内容を示します。
{
"PartyName": "John Smith",
"ResourceType": "INDIVIDUAL",
"FormattedAddress": "500 Oracle Parkway,REDWOOD CITY, CA 944065",
"Username": "jsmith439906587",
"City": "Redwood City",
"Country": "US",
"PostalCode": "944065",
"FirstName": "John",
"LastName": "Smith",
"ResourcePartyNumber": "Conta504976",
"State": "CA",
"ResourceEmail": "john.smith@dnd.vision.com",
"RawWorkPhoneNumber": "6505061212",
"RawMobilePhoneNumber": null,
"RawFaxNumber": null,
"AddressLine1": "500 Oracle Parkway",
"ResourceOrganizationName": "JSmithOrg",
"ResourceOrganizationUsage": "SALES_RESOURCE_ORG",
"ResourceOrgMemRoleEndDate": "4712-12-31",
"ResourceOrgRoleCode":"SALES_VP",
"ResourceParentOrganizationName" : "NA Sales",
"ResourceManagerFirstName": "Phil",
"ResourceManagerLastName": "Gioco",
"HRManagerEmailAddress": "hrMan247134917@vision.com",
"HireDate": "2018-08-20",
"ResourceOrgMemRoleStartDate": "2018-08-20",
"ResourceManagerPartyNumber": "100010034246635",
"ResourceManagerPartyId": 100010034246635,
"PersonNumber": "300100159661235",
"BusinessUnit": "Vision Corporation Enterprise",
"LegalEntity": "Vision Corporation",
"UserStatus": "A",
"PersonType": "EMP",
"CreateUserAccountFlag": null,
...
}
内部リソースの促進または後退
次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行することによって、内部リソースをプロモートまたはデモートする方法を示しています。
cURLコマンド
curl --user sales_cloud_user -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.19.01/resourceUsers/Conta504976
リクエスト本文の例
次に、JSON形式のリクエスト本文の内容を示します。
{
"ResourceOrgRoleCode":"SALES_VP"
}
レスポンス本文の例
次に、JSON形式のレスポンス本文の内容を示します。
{
"PartyName": "John Smith",
"ResourceType": "INDIVIDUAL",
"FormattedAddress": "500 Oracle Parkway,REDWOOD CITY, CA 944065",
"Username": "jsmith439906587",
"City": "Redwood City",
"Country": "US",
"PostalCode": "944065",
"FirstName": "John",
"LastName": "Smith",
"ResourcePartyNumber": "Conta504976",
"State": "CA",
"ResourceEmail": "john.smith@dnd.vision.com",
"RawWorkPhoneNumber": "6505061212",
"RawMobilePhoneNumber": null,
"RawFaxNumber": null,
"AddressLine1": "500 Oracle Parkway",
"ResourceOrganizationName": "JSmithOrg",
"ResourceOrganizationUsage": "SALES_RESOURCE_ORG",
"ResourceOrgMemRoleEndDate": "4712-12-31",
"ResourceOrgRoleCode":"SALES_VP",
"ResourceParentOrganizationName" : "NA Sales",
"ResourceManagerFirstName": "Phil",
"ResourceManagerLastName": "Gioco",
"HRManagerEmailAddress": "hrMan247134917@vision.com",
"HireDate": "2018-08-20",
"ResourceOrgMemRoleStartDate": "2018-08-20",
"ResourceManagerPartyNumber": "100010034246635",
"ResourceManagerPartyId": 100010034246635,
"PersonNumber": "300100159661235",
"BusinessUnit": "Vision Corporation Enterprise",
"LegalEntity": "Vision Corporation",
"UserStatus": "A",
"PersonType": "EMP",
"CreateUserAccountFlag": null,
...
}
内部リソースの促進または後退
次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行することによって、内部リソースをプロモートまたはデモートする方法を示しています。
cURLコマンド
curl --user sales_cloud_user -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.19.01/resourceUsers/Conta504976
リクエスト本文の例
次に、JSON形式のリクエスト本文の内容を示します。
{
"ResourceOrgRoleCode":"SALES_VP"
}
レスポンス本文の例
次に、JSON形式のレスポンス本文の内容を示します。
{
"PartyName": "John Smith",
"ResourceType": "INDIVIDUAL",
"FormattedAddress": "500 Oracle Parkway,REDWOOD CITY, CA 944065",
"Username": "jsmith439906587",
"City": "Redwood City",
"Country": "US",
"PostalCode": "944065",
"FirstName": "John",
"LastName": "Smith",
"ResourcePartyNumber": "Conta504976",
"State": "CA",
"ResourceEmail": "john.smith@dnd.vision.com",
"RawWorkPhoneNumber": "6505061212",
"RawMobilePhoneNumber": null,
"RawFaxNumber": null,
"AddressLine1": "500 Oracle Parkway",
"ResourceOrganizationName": "JSmithOrg",
"ResourceOrganizationUsage": "SALES_RESOURCE_ORG",
"ResourceOrgMemRoleEndDate": "4712-12-31",
"ResourceOrgRoleCode":"SALES_VP",
"ResourceParentOrganizationName" : "NA Sales",
"ResourceManagerFirstName": "Phil",
"ResourceManagerLastName": "Gioco",
"HRManagerEmailAddress": "hrMan247134917@vision.com",
"HireDate": "2018-08-20",
"ResourceOrgMemRoleStartDate": "2018-08-20",
"ResourceManagerPartyNumber": "100010034246635",
"ResourceManagerPartyId": 100010034246635,
"PersonNumber": "300100159661235",
"BusinessUnit": "Vision Corporation Enterprise",
"LegalEntity": "Vision Corporation",
"UserStatus": "A",
"PersonType": "EMP",
"CreateUserAccountFlag": null,
...
}
内部リソースの転送
次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行することによって内部リソースを転送する方法を示しています。
cURLコマンド
curl --user sales_cloud_user -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.19.01/resourceUsers/Conta855676
リクエスト本文の例
次に、JSON形式のリクエスト本文の内容を示します。
{
"ResourceParentOrganizationName":"GLOBAL_SALES"
}
レスポンス本文の例
次に、JSON形式のレスポンス本文の内容を示します。
{
"PartyName": "Katty Smith",
"ResourceType": "INDIVIDUAL",
"FormattedAddress": "500 Oracle Parkway,REDWOOD CITY, CA 944065",
"City": "Redwood City",
"Country": "US",
"PostalCode": "944065",
"FirstName": "Katty",
"LastName": "Smith",
"ResourcePartyNumber": "Conta855676",
"State": "CA",
"ResourceEmail": "katty.smith@dnd.vision.com",
"RawWorkPhoneNumber": "6505061212",
"RawMobilePhoneNumber": null,
"RawFaxNumber": null,
"AddressLine1": "500 Oracle Parkway",
"ResourceOrganizationName": "KSmithOrg",
"ResourceOrganizationUsage": "SALES_RESOURCE_ORG",
"ResourceOrgMemRoleEndDate": "4712-12-31",
"ResourceOrgRoleCode":"SALES_REPRESENTATIVE",
"ResourceParentOrganizationName" : "GLOBAL_SALES",
"ResourceManagerFirstName": "Phil",
"ResourceManagerLastName": "Gioco",
"HRManagerEmailAddress": "hrMan247134917@vision.com",
"HireDate": "2018-08-20",
"ResourceOrgMemRoleStartDate": "2018-08-20",
"ResourceManagerPartyNumber": "100010034246635",
"ResourceManagerPartyId": 100010034246635,
"PersonNumber": "300100159661235",
"BusinessUnit": "Vision Corporation Enterprise",
"LegalEntity": "Vision Corporation",
"UserStatus": "A",
"PersonType": "EMP",
"CreateUserAccountFlag": null,
...
}
内部リソースの終了日
次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行することによって、内部リソースを終了する方法を示しています。
cURLコマンド
curl --user sales_cloud_user -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.19.01/resourceUsers/Conta765982
リクエスト本文の例
次に、JSON形式のリクエスト本文の内容を示します。
{
"ResourceEndDate": "2019-06-31"
}
レスポンス本文の例
次に、JSON形式のレスポンス本文の内容を示します。
{
"ResourceProfileId": 300100159661456,
"PartyName": "Diane Cho",
"LastUpdateDate": "2018-08-20T18:34:56.289+00:00",
"LastUpdatedBy": "SALES_ADMIN",
"CreationDate": "2018-08-20T18:34:29.001+00:00",
"CreatedBy": "SALES_ADMIN",
"ResourceType": "INDIVIDUAL",
"FormattedAddress": "100 Market Street,SAN FRANCISCO, CA 94105",
"TimezoneCode": null,
"Username": "dcho",
"City": "San Francisco",
"Country": "US",
"PostalCode": "94105",
"UpdateFlag": "true",
"DeleteFlag": "false",
"FirstName": "Diane",
"LastName": "Cho",
"MiddleName": null,
"Title": null,
"ResourcePartyNumber": "Conta765982",
"State": "CA",
"ResourceEmail": "diane.cho@dnd.vision.com",
"RawWorkPhoneNumber": "4155551212",
"RawMobilePhoneNumber": null,
"RawFaxNumber": null,
"AddressLine1": "100 Market Street",
"AddressLine2": null,
"ResourceStartDate": "2018-08-20",
"ResourceEndDate": "2019-06-31",
"ResourcePartyId": 300100159661457,
"ResourceOrganizationName": "NA Sales",
"ResourceOrganizationUsage": "SALES_RESOURCE_ORG",
"ResourceOrgMemRoleEndDate": "4712-12-31",
"ResourceOrgRoleCode": "SALES_REPRESENTATIVE",
"ResourceParentOrganizationName": "NA Sales",
"ResourceOrgManagerEmail": "CEO.CRM+TM40@ap6023fems.us.vision.com",
"ResourceManagerName": null,
"ResourceManagerFirstName": "Phil",
"ResourceManagerLastName": "Gioco",
"HRManagerEmailAddress": "hrMan247134917@vision.com",
"HireDate": "2018-08-20",
"ResourceOrgMemRoleStartDate": "2018-08-20",
"ResourceManagerPartyNumber": "100010034246635",
"County": null,
"Province": null,
"ResourceManagerPartyId": 100010034246635,
"PersonNumber": "300100159661466",
"BusinessUnit": "Vision Corporation Enterprise",
"LegalEntity": "Vision Corporation",
"JobCode": null,
"JobTitle": null,
"UserStatus": "I",
"PersonType": "EMP",
...
}
ユーザー・アカウントの一時停止
次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行して、ユーザー・アカウントを一時停止する方法を示しています。
ノート:
内部リソースのアカウントを一時停止し、リソース属性も変更する場合は、次のプロセスを使用します。 ユーザー・アカウントを一時停止し、リソース属性を変更しない場合は、ユーザーREST APIを使用します。cURLコマンド
curl --user sales_cloud_user -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.19.01/resourceUsers/Conta765982
リクエスト本文の例
次に、JSON形式のリクエスト本文の内容を示します。
{
"UserStatus" : "S"
}
レスポンス本文の例
次に、JSON形式のレスポンス本文の内容を示します。
{
"ResourceProfileId": 300100159661456,
"PartyName": "Diane Cho",
"LastUpdateDate": "2018-08-20T18:34:56.289+00:00",
"LastUpdatedBy": "SALES_ADMIN",
"CreationDate": "2018-08-20T18:34:29.001+00:00",
"CreatedBy": "SALES_ADMIN",
"ResourceType": "INDIVIDUAL",
"FormattedAddress": "100 Market Street,SAN FRANCISCO, CA 94105",
"TimezoneCode": null,
"Username": "dcho",
"City": "San Francisco",
"Country": "US",
"PostalCode": "94105",
"UpdateFlag": "true",
"DeleteFlag": "false",
"FirstName": "Diane",
"LastName": "Cho",
"MiddleName": null,
"Title": null,
"ResourcePartyNumber": "Conta765982",
"State": "CA",
"ResourceEmail": "diane.cho@dnd.vision.com",
"RawWorkPhoneNumber": "4155551212",
"RawMobilePhoneNumber": null,
"RawFaxNumber": null,
"AddressLine1": "100 Market Street",
"AddressLine2": null,
"ResourceStartDate": "2018-08-20",
"ResourceEndDate": "2019-01-31",
"ResourcePartyId": 300100159661457,
"ResourceOrganizationName": "NA Sales",
"ResourceOrganizationUsage": "SALES_RESOURCE_ORG",
"ResourceOrgMemRoleEndDate": "4712-12-31",
"ResourceOrgRoleCode": "SALES_REPRESENTATIVE",
"ResourceParentOrganizationName": "NA Sales",
"ResourceOrgManagerEmail": "CEO.CRM+TM40@ap6023fems.us.vision.com",
"ResourceManagerName": null,
"ResourceManagerFirstName": "Phil",
"ResourceManagerLastName": "Gioco",
"HRManagerEmailAddress": "hrMan247134917@vision.com",
"HireDate": "2018-08-20",
"ResourceOrgMemRoleStartDate": "2018-08-20",
"ResourceManagerPartyNumber": "100010034246635",
"County": null,
"Province": null,
"ResourceManagerPartyId": 100010034246635,
"PersonNumber": "300100159661466",
"BusinessUnit": "Vision Corporation Enterprise",
"LegalEntity": "Vision Corporation",
"JobCode": null,
"JobTitle": null,
"UserStatus": "S",
"PersonType": "EMP",
...
}
ユーザー・アカウントの再アクティブ化
次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行して、ユーザー・アカウントを再アクティブ化する方法を示しています。
cURLコマンド
curl --user sales_cloud_user -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.19.01/resourceUsers/Conta765982
リクエスト本文の例
次に、JSON形式のリクエスト本文の内容を示します。
{
"UserStatus" : "A"
}
レスポンス本文の例
次に、JSON形式のレスポンス本文の内容を示します。
{
"ResourceProfileId": 300100159661456,
"PartyName": "Diane Cho",
"LastUpdateDate": "2018-08-20T18:34:56.289+00:00",
"LastUpdatedBy": "SALES_ADMIN",
"CreationDate": "2018-08-20T18:34:29.001+00:00",
"CreatedBy": "SALES_ADMIN",
"ResourceType": "INDIVIDUAL",
"FormattedAddress": "100 Market Street,SAN FRANCISCO, CA 94105",
"TimezoneCode": null,
"Username": "dcho",
"City": "San Francisco",
"Country": "US",
"PostalCode": "94105",
"UpdateFlag": "true",
"DeleteFlag": "false",
"FirstName": "Diane",
"LastName": "Cho",
"MiddleName": null,
"Title": null,
"ResourcePartyNumber": "Conta765982",
"State": "CA",
"ResourceEmail": "diane.cho@dnd.vision.com",
"RawWorkPhoneNumber": "4155551212",
"RawMobilePhoneNumber": null,
"RawFaxNumber": null,
"AddressLine1": "100 Market Street",
"AddressLine2": null,
"ResourceStartDate": "2018-08-20",
"ResourceEndDate": "2019-01-31",
"ResourcePartyId": 300100159661457,
"ResourceOrganizationName": "NA Sales",
"ResourceOrganizationUsage": "SALES_RESOURCE_ORG",
"ResourceOrgMemRoleEndDate": "4712-12-31",
"ResourceOrgRoleCode": "SALES_REPRESENTATIVE",
"ResourceParentOrganizationName": "NA Sales",
"ResourceOrgManagerEmail": "CEO.CRM+TM40@ap6023fems.us.vision.com",
"ResourceManagerName": null,
"ResourceManagerFirstName": "Phil",
"ResourceManagerLastName": "Gioco",
"HRManagerEmailAddress": "hrMan247134917@vision.com",
"HireDate": "2018-08-20",
"ResourceOrgMemRoleStartDate": "2018-08-20",
"ResourceManagerPartyNumber": "100010034246635",
"County": null,
"Province": null,
"ResourceManagerPartyId": 100010034246635,
"PersonNumber": "300100159661466",
"BusinessUnit": "Vision Corporation Enterprise",
"LegalEntity": "Vision Corporation",
"JobCode": null,
"JobTitle": null,
"UserStatus": "A",
"PersonType": "EMP",
...
}