すべての連絡先の取得
get
/fscmRestApi/resources/11.13.18.05/suppliers/{SupplierId}/child/contacts
リクエスト
パス・パラメータ
- SupplierId(required): integer(int64)
サプライヤを一意に識別する値。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前に、親リソース・インスタンスにフィールドが設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees、Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- PrimaryKey : 主キーに従ってサプライヤ担当を検索します。
ファインダ変数:- PersonProfileId; integer; 個人プロファイルを一意に識別する値。
- SupplierContactId; integer; サプライヤ担当を一意に識別する値。
- PrimaryKeyFinder : 主キーに従ってサプライヤ担当を検索します。
ファインダ変数:- SupplierContactId; string; サプライヤ担当者を一意に識別する値。
- PrimaryKey : 主キーに従ってサプライヤ担当を検索します。
- limit: integer
このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
- links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- offset: integer
リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
- onlyData: boolean
データのみを含めるために(リンク・セクションなしなど)、リソース品目ペイロードがフィルタ処理されます。
- orderBy: string
このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:desc
- q: string
この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;事業所=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能な属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- AdministrativeContactFlag; boolean; 次の値のいずれかを含みます: trueまたはfalse。 trueの場合、サプライヤは管理担当者です。 falseの場合、サプライヤは管理担当者ではありません。 デフォルト値はfalseです。
- Email; string; サプライヤ担当のEメール。
- FaxAreaCode; string; サプライヤ担当者のFAXのエリアを識別する略称。
- FaxCountryCode; string; サプライヤ担当者のFAXの国を識別する略称。
- FaxNumber; string; 仕入先担当者のFAX。
- FirstName; string; 仕入先担当者の名。
- JobTitle; string; サプライヤ担当者のジョブ・タイトル。
- LastName; string; サプライヤ担当者の姓。
- MiddleName; string; サプライヤ担当者のミドル・ネーム。
- MobileAreaCode; string; サプライヤ担当者の携帯電話のエリアを識別する略称。
- MobileCountryCode; string; サプライヤ担当者の携帯電話の国を識別する略称。
- MobileNumber; string; サプライヤ担当者の携帯電話番号。
- PersonProfileId; integer; 個人プロファイルを一意に識別する値。
- PhoneAreaCode; string; サプライヤ担当者の電話のエリアを識別する略称。
- PhoneCountryCode; string; サプライヤ担当者の電話の国を識別する略称。
- PhoneExtension; string; サプライヤ担当者の内線番号。
- PhoneNumber; string; 仕入先担当者の電話。
- Salutation; string; サプライヤ担当の敬称。
- SalutationCode; string; サプライヤ担当者の敬称を識別する略称。 使用可能な値のリストは、参照タイプCONTACT_TITLEで定義されます。 設定およびメンテナンス作業領域および標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- SupplierContactId; integer; サプライヤ担当を一意に識別する値。
- totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻るレスポンス
サポートされているメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : suppliers-contacts
タイプ:
ソースを表示
object
-
count(required): integer
現在の範囲内で返されるリソース・インスタンス数。
-
hasMore(required): boolean
サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースが増えます。 デフォルト値はfalseです。
-
items: array Items
タイトル:
Items
コレクション内の品目。 -
limit(required): integer
サーバーで使用される実際のページング・サイズ。
-
links(required): array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
offset(required): integer
現在のページで使用されるオフセット値。
-
totalResults: integer
"?totalResults=true"の場合、推定行数は含まれません。
ネストされたスキーマ : suppliers-contacts-item-response
タイプ:
ソースを表示
object
-
addresses: array Contact Addresses
タイトル:
Contact Addresses
担当者住所リソースは、サプライヤ担当住所を管理します。 -
AdministrativeContactFlag: boolean
タイトル:
Administrative contact
最大長:255
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サプライヤは管理担当者です。 falseの場合、サプライヤは管理担当者ではありません。 デフォルト値はfalseです。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
サプライヤ・レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
ユーザーがサプライヤ・レコードを作成した日付。 -
DFF: array Flexfields for Supplier Contacts
タイトル:
Flexfields for Supplier Contacts
サプライヤ担当リソースのフレックスフィールドは、サプライヤ担当付加フレックスフィールドを管理します。 -
Email: string
タイトル:
Email
最大長:320
サプライヤ担当者の電子メール。 -
FaxAreaCode: string
タイトル:
Fax Area Code
最大長:20
サプライヤ担当者のFAXのエリアを識別する略称です。 -
FaxCountryCode: string
タイトル:
Fax Country Code
最大長:10
サプライヤ担当者のFAXの国を識別する略称です。 -
FaxNumber: string
タイトル:
Fax
最大長:40
サプライヤ担当者のFAXです。 -
FirstName: string
タイトル:
First Name
最大長:150
仕入先担当者の名。 -
InactiveDate: string (date)
タイトル:
Inactive Date
サプライヤ担当がアクティブでなくなった日付。 -
JobTitle: string
タイトル:
Job Title
最大長:100
サプライヤ担当者のジョブ・タイトル。 -
LastName: string
タイトル:
Last Name
最大長:150
仕入先担当者の姓。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
ユーザーが最後にサプライヤ・レコードを更新した日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
最後にサプライヤ・レコードを更新したユーザー。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MiddleName: string
タイトル:
Middle Name
最大長:60
サプライヤ担当者のミドル・ネーム。 -
MobileAreaCode: string
タイトル:
Mobile Area Code
最大長:20
サプライヤ担当者の携帯電話のエリアを識別する略称です。 -
MobileCountryCode: string
タイトル:
Mobile Country Code
最大長:10
サプライヤ担当者の携帯電話の国を識別する略称です。 -
MobileNumber: string
タイトル:
Mobile
最大長:40
サプライヤ担当者の携帯電話番号。 -
PersonProfileId: integer (int64)
個人プロファイルを一意に識別する値。
-
PhoneAreaCode: string
タイトル:
Phone Area Code
最大長:20
サプライヤ担当者の電話のエリアを識別する略称です。 -
PhoneCountryCode: string
タイトル:
Phone Country Code
最大長:10
サプライヤ担当者の電話の国を識別する略称です。 -
PhoneExtension: string
タイトル:
Phone Extension
最大長:20
サプライヤ担当者の電話拡張です。 -
PhoneNumber: string
タイトル:
Phone
最大長:40
サプライヤ担当者の電話です。 -
Salutation: string
タイトル:
Salutation
最大長:80
サプライヤ担当者の敬称。 -
SalutationCode: string
タイトル:
Salutation
最大長:30
サプライヤ担当者の敬称を識別する略称です。 使用可能な値のリストは、参照タイプCONTACT_TITLEで定義されます。 設定およびメンテナンス作業領域および標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
Status: string
タイトル:
Status
読取り専用:true
最大長:255
サプライヤ担当者のステータス。 -
SupplierContactId: integer (int64)
読取り専用:
true
サプライヤ担当を一意に識別する値。
ネストされたスキーマ : サプライヤ担当のフレックスフィールド
タイプ:
array
タイトル:
Flexfields for Supplier Contacts
サプライヤ担当リソースのフレックスフィールドは、サプライヤ担当付加フレックスフィールドを管理します。
ソースを表示
ネストされたスキーマ : suppliers-contacts-addresses-item-response
タイプ:
ソースを表示
object
-
AddressName: string
タイトル:
Address Name
最大長:255
サプライヤ担当者に関連付けられたサプライヤ住所の名前。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
サプライヤ・レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
ユーザーがサプライヤ・レコードを作成した日付。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
ユーザーが最後にサプライヤ・レコードを更新した日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
最後にサプライヤ・レコードを更新したユーザー。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
SupplierAddressId: integer (int64)
サプライヤ担当に関連付けられたサプライヤ住所を一意に識別する値です。
-
SupplierContactAddressId: integer
サプライヤ担当住所を一意に識別する値。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
object
-
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.
ネストされたスキーマ : suppliers-contacts-DFF-item-response
タイプ:
ソースを表示
object
-
__FLEX_Context: string
タイトル:
Enter Person Information
最大長:30
サプライヤ・サイトの付加フレックスフィールド・コンテキスト名です。 -
__FLEX_Context_DisplayValue: string
タイトル:
Enter Person Information
サプライヤ・サイトの付加フレックスフィールド・コンテキスト表示値。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PersonProfileId: integer (int64)
個人プロファイルを一意に識別する値。
例
この例では、すべての連絡先を取得する方法について説明します。
cURLコマンドの例
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:
curl -u username:password "https://servername/fscmRestApi/resources/version/suppliers/SupplierId/child/contacts"
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{ "items" : [ { "SupplierContactId" : 100000011547058, "PersonProfileId" : 100000011547059, "SalutationCode" : null, "Salutation" : null, "FirstName" : "Henry", "MiddleName" : null, "LastName" : "Jones", "JobTitle" : null, "AdministrativeContactFlag" : true, "PhoneCountryCode" : null, "PhoneAreaCode" : null, "PhoneNumber" : null, "PhoneExtension" : null, "MobileCountryCode" : null, "MobileAreaCode" : null, "MobileNumber" : null, "FaxCountryCode" : null, "FaxAreaCode" : null, "FaxNumber" : null, "Email" : "sendmail-test-discard@example.com", "Status" : "ACTIVE", "InactiveDate" : null "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/100000011547058", "name" : "contacts", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000067704000000067372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C71007E000371007E000371007E000371007E000371007E000378" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/100000011547058", "name" : "contacts", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230", "name" : "suppliers", "kind" : "item" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/100000011547058/lov/SalutationLookup", "name" : "SalutationLookup", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/100000011547058/child/DFF", "name" : "DFF", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/100000011547058/child/addresses", "name" : "addresses", "kind" : "collection" } ] }, { "SupplierContactId" : 100000011552266, "PersonProfileId" : 100000011552267, "SalutationCode" : null, "Salutation" : null, "FirstName" : "Emily", "MiddleName" : null, "LastName" : "Jones", "JobTitle" : null, "AdministrativeContactFlag" : true, "PhoneCountryCode" : null, "PhoneAreaCode" : null, "PhoneNumber" : null, "PhoneExtension" : null, "MobileCountryCode" : null, "MobileAreaCode" : null, "MobileNumber" : null, "FaxCountryCode" : null, "FaxAreaCode" : null, "FaxNumber" : null, "Email" : "sendmail-test-discard@example.com", "Status" : "ACTIVE", "InactiveDate" : null "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/100000011552266", "name" : "contacts", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000067704000000067372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C71007E000371007E000371007E000371007E000371007E000378" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/100000011552266", "name" : "contacts", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230", "name" : "suppliers", "kind" : "item" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/100000011552266/lov/SalutationLookup", "name" : "SalutationLookup", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/100000011552266/child/DFF", "name" : "DFF", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts/100000011552266/child/addresses", "name" : "addresses", "kind" : "collection" } ] } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/suppliers/230/child/contacts", "name" : "contacts", "kind" : "collection" } ] }