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

すべてのリソースの取得

get

/crmRestApi/resources/11.13.18.05/resources

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • EmailAddressAltKey : Eメール・アドレスでリソースを検索します。
      ファインダ変数:
      • EmailAddress; string;リソースの電子メール・アドレス。
    • FilterByManagerReportsFlagRF : マネージャのレポート・フラグに基づいてリソースを検索します。
      ファインダ変数:
      • BindSysdate; string;マネージャ・レポート・フラグに基づくリソースの識別子。
    • PartyIdAltKey : パーティIDでリソースを検索します。
      ファインダ変数:
      • PartyId; integer; リソース・パーティの一意の識別子。
    • PartyNumberAltKey : パーティ番号でリソースを検索します。
      ファインダ変数:
      • PartyNumber; string;リソース・パーティの一意の識別子。
    • PrimaryKey : 指定された主キーでリソースを検索します。
      ファインダ変数:
      • ResourceProfileId; integer; リソース・プロファイルの一意の主キー識別子。
    • ResourcePartyNumberRF : 指定されたパーティ番号でリソースを検索します。
      ファインダ変数:
      • PartyNumber; string;リソース・パーティの一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CreatedBy;文字列; Who列: 行を作成したユーザーを示します。
    • CreationDate;文字列; Who列: 行の作成日時を示します。
    • EmailAddress; string;リソースの電子メール・アドレス。
    • EndDateActive; string;このリソースがアクティブでなくなる日付。
    • LastUpdateDate;文字列; Who列: 行の最終更新日時を示します。
    • LastUpdateLogin;文字列; Who列: 行を最後に更新したユーザーに関連付けられているセッション・ログインを示します。
    • LastUpdatedBy;文字列; Who列: 行を最後に更新したユーザーを示します。
    • Manager; string;このリソースのマネージャの名前。
    • PartyId; integer;リソース・パーティの一意の識別子。
    • PartyName; string;リソース・パーティの名前。
    • PartyNumber; string; リソース・パーティの代替キー識別子。
    • PersonFirstName; string;リソースの名。
    • PersonLastName; string;リソースの姓。
    • PrimaryOrganization; string; このリソースのプライマリ組織。
    • RecordSet; string; 定義された基準に一致するリソースをグループ化するレコード・セット。
    • ResourceOrgRoleCode; string;リソースに割り当てられたロールのコード値。
    • ResourceOrgRoleName; string; 組織または階層内のリソースの機能を定義するロール。
    • ResourceProfileId; integer; リソース・プロファイルの一意の主キー識別子。
    • StartDateActive; string;リソースがアクティブになる日付。
    • Username; string;このリソースに関連付けられたユーザー・アカウントの名前
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : リソース
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : resources-item-response
タイプ: object
ソースを表示
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    Who列: 行の作成ユーザーを示します。
  • タイトル: Creation Date
    読取り専用: true
    Who列: 行の作成日時を示します。
  • 読取り専用: true
    ユーザーがリソースを削除できるかどうかを示します。
  • タイトル: E-Mail
    読取り専用: true
    最大長: 320
    リソースのEメール・アドレス。
  • タイトル: To Date
    このリソースがアクティブでなくなった日付。
  • タイトル: Address
    読取り専用: true
    最大長: 255
    リソースのプライマリ書式化された住所情報。
  • タイトル: Phone
    読取り専用: true
    最大長: 100
    リソースのプライマリ書式付き電話番号。
  • タイトル: Job Title
    読取り専用: true
    従業員であるリソースのジョブ・タイトル。
  • タイトル: Last Updated
    読取り専用: true
    Who列: 行の最終更新日時を示します。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    Who列: 行の最終更新ユーザーを示します。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    Who列: 行を最後に更新したユーザーに関連付けられたセッション・ログインを示します。
  • Links
  • タイトル: Manager
    読取り専用: true
    このリソースのマネージャの名前。
  • タイトル: Manager Party ID
    リソースのマネージャ・パーティの一意の識別子。
  • タイトル: Resource
    リソース・パーティの一意の識別子。
  • タイトル: Resource Name
    読取り専用: true
    最大長: 360
    リソース・パーティの名前。
  • タイトル: Registry ID
    読取り専用: true
    最大長: 30
    リソース・パーティの代替キー識別子。
  • タイトル: First Name
    最大長: 150
    リソースの名。
  • タイトル: Last Name
    最大長: 150
    リソースの姓。
  • タイトル: Last Name Prefix
    読取り専用: true
    最大長: 30
    リソースの姓のプレフィクス。
  • タイトル: Middle Name
    読取り専用: true
    最大長: 60
    リソースのミドル・ネーム。
  • タイトル: Suffix
    読取り専用: true
    最大長: 30
    リソースの名前のサフィクス。
  • タイトル: Salutary Introduction
    読取り専用: true
    最大長: 30
    リソースの優先名前隣接。
  • タイトル: Previous Last Name
    読取り専用: true
    最大長: 150
    リソースの前の姓。
  • タイトル: Second Last Name
    読取り専用: true
    最大長: 150
    リソースの2番目の姓。
  • Picture Attachments
    タイトル: Picture Attachments
    画像添付リソースは、リソースの画像を表示するために使用されます。
  • タイトル: Organization
    読取り専用: true
    このリソースのプライマリ組織。
  • タイトル: Record Set
    定義された条件に一致するリソースをグループ化するレコード・セット。
  • 読取り専用: true
    最大長: 255
    リソースに割り当てられたロールのコード値。
  • 読取り専用: true
    最大長: 255
    組織または階層内のリソースの機能を定義するロール。
  • タイトル: Resource Profile ID
    読取り専用: true
    リソース・プロファイルの一意の主キー識別子。
  • タイトル: Usage
    従業員などのリソースのタイプ。
  • タイトル: Effective As-of Date
    リソースがアクティブになる日付。
  • 読取り専用: true
    ユーザーがリソースを更新できるかどうかを示します。
  • タイトル: Primary URL
    読取り専用: true
    最大長: 2000
    リソースのプライマリURL。
  • タイトル: Usages
    リソース・パーティの読取り専用パーティ使用目的。
  • タイトル: User Name
    読取り専用: true
    このリソースに関連付けられているユーザー・アカウントの名前
ネストされたスキーマ : 画像添付
タイプ: array
タイトル: Picture Attachments
画像添付リソースは、リソースの画像を表示するために使用されます。
ソースを表示
ネストされたスキーマ : resources-PictureAttachment-item-response
タイプ: object
ソースを表示
トップに戻る

例:

cURLコマンド

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

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

サポートされているレコード・セット

リソースは次のレコード・セットをサポートします。

レコード・セット 摘要 cURLコマンド
ORA_MYMANAGERANDPEERS 現在のユーザーのすべてのマネージャおよびピアをリストします。 curl -u <username:password> \ -X http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resources?q=RecordSet='ORA_MYMANAGERANDPEERS'

レスポンス本文の例

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

{
  "items" : [ {
    "ResourceProfileId" : 999990000008056,
    "PartyId" : 2458,
    "PartyName" : "Lisa Pickford",
    "PartyNumber" : "CONTACT-1022",
    "StartDateActive" : "2008-09-04",
    "EndDateActive" : "4712-12-31",
    "ResourceType" : "INDIVIDUAL",
    "PrimaryOrganization" : "VOL RESOURCE ORG 0",    
    "EmailAddress" : "sendmail-test-discard@oracle.com",
    "FormattedAddress" : "320 N First St,SAN JOSE, CA 95113",
    "FormattedPhoneNumber" : "+1 (800) 555-8355 x87",
    "Usage" : "",
    "Manager" : "George Manning",   
    "Url" : null,
    "JobMeaning" : null,    
    "PersonFirstName" : "Lisa",
    "PersonLastName" : "Pickford",
    "PersonLastNamePrefix" : null,
    "PersonMiddleName" : null,
    "PersonNameSuffix" : null,
    "PersonPreNameAdjunct" : "MS.",
    "PersonPreviousLastName" : null,
    "PersonSecondLastName" : null,
    "links" : [ {
      "rel" : "self",
      "href" : "http://.../crmRestApi/resources/11.13.18.05/resources/CONTACT-1022",
      "name" : "resources",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : ""
      }
    }, {
      "rel" : "canonical",
      "href" : "http://.../crmRestApi/resources/11.13.18.05/resources/CONTACT-1022",
      "name" : "resources",
      "kind" : "item"
    } ]
  } ...
  , 
  ],
  "count" : 25,
  "hasMore" : true,
  "limit" : 25,
  "offset" : 0,
  "links" : [ {
    "rel" : "self",
    "href" : "http://.../crmRestApi/resources/11.13.18.05/resources",
    "name" : "resources",
    "kind" : "collection"
  } ]
}
「トップに戻る」