機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 担当者
  4. 追加名

すべての追加名の取得

get

/crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/AdditionalName

リクエスト

パス・パラメータ
  • 担当者パーティの代替キー識別子。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERは、属性値をシステム生成にできるか、作成中にユーザー指定にできるかを制御します。 「設定およびメンテナンス」作業領域、「取引先コミュニティ共通プロファイル・オプションの管理」タスクを使用して、この属性の値をレビューおよび更新します。 非アクティブなレコードは更新できません。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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
  • コレクションを検索するための事前定義済ファインダとして使用されます。

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

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

    • PrimaryKey : 指定された主キーを持つ追加の名前を検索します。
      ファインダ変数:
      • NameId; integer; 名前の一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AcademicTitle; string; Dr. Jane Smithなど、学業資格を示す個人のタイトルの一部。
    • ConflictId; integer; 属性値は、異なるデータベースに重複が作成される場合に、行の一意性を保証するために使用されます。
    • CreatedBy; string; 担当者レコードを作成したユーザー。
    • CreationDate; string; 担当者レコードが作成された日時。
    • 説明;文字列;追加名レコードの説明
    • FirstName; string;個人の名。
    • LastName; string;個人の姓。
    • LastUpdateDate; string; 担当者が最後に更新された日時。
    • LastUpdatedBy; string; 担当者レコードを最後に更新したユーザー。
    • MiddleName; string;個人のミドル・ネーム。
    • Name; string;組織、個人またはグループ・パーティの名前。 たとえば、"Oracle"や"John Smith"などです。
    • NameId; integer; 名前の一意の識別子。
    • NameType; string; 名前のタイプ。 たとえば、ALIASやLEGALです。
    • PartyId; integer;パーティの一意の識別子。
    • PartyNumber; string;パーティの公開一意識別子。
    • PreferredFlag; boolean;この名前タイプ内で、名前をこのパーティの優先名として識別します。 指定可能な値は'Y'および'N'です。 デフォルトはNです。
    • StatusFlag; boolean;レコードをソフト削除するために使用されるレコード・ステータス。 受け入れられる値は、アクティブの場合はA、非アクティブの場合はIです。 デフォルト値はAです。
    • タイトル;文字列; DonやThe Right Honorableなどの専門または家族のタイトル
    • TransliterationLanguage; string; TransliterationLanguageは、外国語で単語と名前を発音する方法です。 FND_LANGUAGES.LANGUAGE_CODEに対して検証されます。 サンプル値: US,NL,DK etc.
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : contacts-AdditionalName
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : contacts-AdditionalName-item-response
タイプ: object
ソースを表示
  • タイトル: Academic Title
    最大長: 30
    学業資格を示す個人のタイトルの一部です(Dr. Jane Smithなど)。
  • デフォルト値: 0
    属性値は、異なるデータベースに重複が作成される場合に、行の一意性を保証するために使用されます。
  • 読取り専用: true
    最大長: 64
    担当者レコードを作成したユーザー。
  • 読取り専用: true
    担当者レコードが作成された日時。
  • タイトル: Description
    最大長: 240
    追加名レコードの説明
  • タイトル: First Name
    最大長: 150
    個人の名。
  • タイトル: Last Name
    最大長: 150
    個人の姓。
  • 読取り専用: true
    担当者が最後に更新された日時。
  • 読取り専用: true
    最大長: 64
    担当者レコードを最後に更新したユーザー。
  • Links
  • タイトル: Middle Name
    最大長: 60
    個人のミドル・ネーム。
  • タイトル: Additional Name
    最大長: 360
    組織、個人またはグループ・パーティの名前。 たとえば、"Oracle"や"John Smith"などです。
  • 読取り専用: true
    名前の一意の識別子。
  • タイトル: Additional Name Type
    最大長: 30
    名前のタイプ。 たとえば、ALIASやLEGALです。
  • パーティの一意識別子
  • タイトル: Registry ID
    読取り専用: true
    最大長: 30
    パーティの公開一意識別子。
  • ソース・システム名。
  • 元のシステムからのレコードの識別子。
  • タイトル: Preferred Indicator
    最大長: 1
    デフォルト値: false
    この名前タイプ内で、このパーティの優先名として名前を識別します。 指定可能な値は'Y'および'N'です。 デフォルトはNです。
  • 関連パーティのソース・システムの名前。
  • 関連パーティのソース・システム参照の識別子。
  • 最大長: 1
    デフォルト値: true
    レコードをソフト削除するために使用するレコード・ステータス。 受け入れられる値は、アクティブの場合はA、非アクティブの場合はIです。 デフォルト値はAです。
  • タイトル: Title
    最大長: 60
    DonやThe Right Honorableなどの専門職または家族のタイトル
  • タイトル: Transliteration Language
    最大長: 4
    TransliterationLanguageは、外国語で単語や名前の発音に役立ちます。 FND_LANGUAGES.LANGUAGE_CODEに対して検証されます。 サンプル値: US,NL,DK etc.
トップに戻る

例:

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

cURLコマンド

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

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
  "items" : [ {
    "Name" : "ABC",
    "NameType" : "ALIAS",
    "NameId" : 300100137039564,
    "StatusFlag" : "A",
    "CreationDate" : "2017-11-16T20:26:06+00:00",
    "CreatedBy" : "SALES_ADMIN",
    "LastUpdateDate" : "2017-11-16T20:26:06.132+00:00",
    "LastUpdatedBy" : "SALES_ADMIN"
    }, 
	{
    "Name" : "ADOPTEDAliasNameBatch",
    "NameType" : "ADOPTED",
    "NameId" : 300100139361396,
    "StatusFlag" : "A",
    "CreationDate" : "2017-11-20T11:21:39.764+00:00",
    "CreatedBy" : "SALES_ADMIN",
    "LastUpdateDate" : "2017-11-20T11:21:41.166+00:00",
    "LastUpdatedBy" : "SALES_ADMIN"
     }, 
	 {
    "Name" : "ALIASAliasNameBatch",
    "NameType" : "ALIAS",
    "NameId" : 300100139361390,
    "StatusFlag" : "A",
    "CreationDate" : "2017-11-20T11:20:23+00:00",
    "CreatedBy" : "SALES_ADMIN",
    "LastUpdateDate" : "2017-11-20T11:20:23.091+00:00",
    "LastUpdatedBy" : "SALES_ADMIN"
      }
...	
	 ],
  "count" : 21,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  ...
  }
「トップに戻る」