機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. リソース・ユーザー

リソース・ユーザーの取得

get

/crmRestApi/resources/11.13.18.05/resourceUsers/{resourceUsersUniqID}

リクエスト

パス・パラメータ
  • これは、リソース・ユーザー・リソースのコンポジット・キーを構成し、リソース・ユーザーのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、ハッシュ・キーを取得するためにリソース・ユーザーの特定のインスタンスに移動するために、リソース・ユーザー・コレクション・リソースを問い合せる必要があります。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : resourceUsers-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : リソース・ロール割当
タイプ: array
タイトル: Resource Role Assignments
リソース・ロール割当リソースは、リソースに割り当てられたロール(実装者、再販業者など)を表示するために使用されます。
ソースを表示
ネストされたスキーマ : resourceUsers-ResourceRoleAssign-item-response
タイプ: object
ソースを表示
リンク
FaxCountryCodeVA
LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: FaxCountryCode;ターゲット属性: PhoneCountryCode
  • 表示属性: PhoneCountryCode, TerritoryShortName
MobilePhoneCountryCodeVA
LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: MobilePhoneCountryCode;ターゲット属性: PhoneCountryCode
  • 表示属性: PhoneCountryCode, TerritoryShortName
ResourceRoleAssign
パラメータ:
  • resourceUsersUniqID: $request.path.resourceUsersUniqID
リソース・ロール割当リソースは、リソースに割り当てられたロール(実装者、再販業者など)を表示するために使用されます。
WorkPhoneCountryCodeVA
LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: WorkPhoneCountryCode;ターゲット属性: PhoneCountryCode
  • 表示属性: PhoneCountryCode, TerritoryShortName
トップに戻る

例:

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

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resourceUsers/CDRM_977317

レスポンス本文の例

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

{
  "ResourceProfileId": 300100187632523,
  "PartyName": "Lokesh Chugh",
  "LastUpdateDate": "2020-07-23T08:23:09.908+00:00",
  "LastUpdatedBy": "MHoope",
  "CreationDate": "2020-07-23T08:22:33.003+00:00",
  "CreatedBy": "MHoope",
  "ResourceType": "INDIVIDUAL",
  "FormattedAddress": "Line 1,5 Cross,FLORENCE, CA 90001",
  "TimezoneCode": null,
  "Username": "LOKESHCHUGH",
  "City": "Florence",
  "Country": "US",
  "PostalCode": "90001",
  "UpdateFlag": "true",
  "DeleteFlag": "false",
  "ResourceOrgRoleCode": "SALES_REPRESENTATIVE",
  "ResourceOrgRoleName": "Salesperson",
  "FirstName": "Lokesh",
  "LastName": "Chugh",
  "MiddleName": null,
  "Title": "MR.",
  "ResourcePartyNumber": "CDRM_977317",
  "State": "CA",
  "ResourceEmail": "lokesh.chugh.01@oracle.com",
  "RawWorkPhoneNumber": "6505061410",
  "RawMobilePhoneNumber": "659123457",
  "RawFaxNumber": null,
  "AddressLine1": "Line 1",
  "AddressLine2": "5 Cross",
  "ResourceStartDate": "2020-07-23",
  "ResourceEndDate": "4712-12-31",
  "ResourcePartyId": 300100187632524,
  "ResourceOrganizationName": "Alan Tan Org",
  "ResourceOrganizationUsage": "SALES_RESOURCE_ORG",
  "ResourceOrgMemRoleEndDate": "4712-12-31",
  "ResourceParentOrganizationName": "Alan Tan Org",
  "ResourceOrgManagerEmail": "alan.tan.01@oracle.com",
  "ResourceManagerName": "Alan Tan",
  "ResourceManagerFirstName": "Alan",
  "ResourceManagerLastName": "Tan",
  "HRManagerEmailAddress": null,
  "HireDate": "2020-07-23",
  "ResourceOrgMemRoleStartDate": "2020-07-23",
  "IndividualRoleCode": "SALES_REPRESENTATIVE",
  "IndividualRoleStartDate": "2020-07-23",
  "IndividualRoleEndDate": "4712-12-31",
  "ResourceManagerPartyNumber": "CDRM_977314",
  "County": null,
  "Province": null,
  "ResourceManagerPartyId": 300100187632390,
  "TopResourceFlag": null,
  "FaxCountryCode": null,
  "WorkPhoneCountryCode": "1",
  "MobilePhoneCountryCode": "1",
  "PersonNumber": "300100187632535",
  "BusinessUnit": "Vision Operations",
  "LegalEntity": "Vision Corporation",
  "JobCode": null,
  "JobTitle": null,
  "UserStatus": "A",
  "PersonType": "EMP",
  "CreateUserAccountFlag": null,
    "links": [
...
		]
}

ノート:

RecordSetは参照タイプです。 RecordSetを使用してリソースをフィルタできます。 レコード・セットは、次の値を使用してリソースRESTおよびリソース・ユーザーRESTでサポートされます:
  • ORA_MYDIRECTS- 自分の直属の部下: 自分の直属の部下であるリソース。
  • ORA_MYREPORTEES- すべての直属の部下および間接的部下: 自分の直属の部下または間接的部下であるリソース。
  • ORA_MYMANAGERANDPEERS- マネージャとピア: 自分のピアまたは自分のマネージャであるリソース。

URLの例

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resourceUsers?q=RecordSet='ORA_MYMANAGERANDPEERS'

Eメールによる内部リソースの取得

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、ResourceEmailファインダで電子メールIDを指定してリソース・ユーザーを取得する方法を示しています。

cURLコマンド

curl --user sales_cloud_user -X GET -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resourceUsers?q=ResourceEmail='john.smith@dnd.vision.com'

レスポンス本文の例

次の例は、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_MANAGER",
 "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リソースに対するGETリクエストを発行することによって、ユーザー名ファインダでユーザー名を指定してリソース・ユーザーを取得する方法を示しています。 そのような例については、「営業リソース・ライフ・サイクルの管理」を参照してください。

cURLコマンド

curl --user sales_cloud_user -X GET -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resourceUsers?q=Username='jdoe439906587'

レスポンス本文の例

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

{
 "PartyName": "Jane Doe",
 "ResourceType": "INDIVIDUAL",
 "FormattedAddress": "500 Oracle Parkway,REDWOOD CITY, CA 944065",
 "Username": "jdoe439906587",
 "City": "Redwood City",
 "Country": "US",
 "PostalCode": "944065",
 "FirstName": "John",
 "LastName": "Smith",
 "ResourcePartyNumber": "Conta765976",
 "State": "CA",
 "ResourceEmail": "jane.doe@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_REPRESENTATIVE",
 "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,
...
}
「トップに戻る」