サプライヤ登録のすべてのサプライヤ担当の取得
get
/fscmRestApi/resources/11.13.18.05/supplierRegistrationRequests/{SupplierRegistrationKey}/child/contacts
リクエスト
パス・パラメータ
- SupplierRegistrationKey(required): string
このパラメータの値は、リソース品目を一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース品目にナビゲートする必要があります。 たとえば: products?q=InventoryItemId=
問合せパラメータ
- 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
コレクションを検索するための事前定義済ファインダとして使用されます。
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します- PrimaryKey主キーに従って、サプライヤ登録のサプライヤ担当を検索します。
ファインダ変数- SupplierRegistrationContactId; integer; 担当者識別子を使用して登録内のサプライヤ担当者を一意に識別する値。
- 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の場合、サプライヤは管理contact.Theのデフォルト値ではなくfalseです。
- CreateUserAccountFlag; boolean; 次の値のいずれかを含みます: trueまたはfalse。 trueの場合、サプライヤ担当のユーザー・アカウントを作成します。 falseの場合、サプライヤ担当のユーザー・アカウントは作成しないでください。 デフォルト値はfalseです。
- Email; string; 登録内のサプライヤ担当者の電子メール。
- FaxAreaCode; string; サプライヤ登録におけるサプライヤ担当者のFAX番号のエリアを識別する略称。
- FaxCountryCode; string; サプライヤ登録におけるサプライヤ担当者のFAX番号の国を識別する略称です。
- FaxNumber; string; サプライヤ登録内のサプライヤ担当者のFAX番号。
- FirstName; string; 仕入先登録における仕入先担当者の名。
- JobTitle; string; サプライヤ登録内のサプライヤ担当者のジョブ・タイトル。
- LastName; string; 仕入先登録における仕入先担当者の姓。
- MiddleName; string; サプライヤ登録内のサプライヤ担当者のミドル・ネーム。
- MobileAreaCode; string; サプライヤ登録におけるサプライヤ担当者の携帯電話番号のエリアを識別する略称。
- MobileCountryCode; string; サプライヤ登録におけるサプライヤ担当者の携帯電話番号の国を識別する略称です。
- MobileNumber; string; サプライヤ登録におけるサプライヤ担当者の携帯電話番号。
- PhoneAreaCode; string; サプライヤ登録におけるサプライヤ担当者の地線電話番号のエリアを識別する略称。
- PhoneCountryCode; string; サプライヤ登録におけるサプライヤ担当者の地線電話番号の国を識別する略称。
- PhoneExtension; string; サプライヤ登録におけるサプライヤ担当者の電話内線番号。
- PhoneNumber; string; サプライヤ登録におけるサプライヤ担当者のLandline電話番号。
- Salutation; string; サプライヤ登録のサプライヤ担当の敬称。
- SalutationCode; string; サプライヤ登録におけるサプライヤ担当者の敬称を識別する略称。 使用可能な値のリストは、参照タイプCONTACT_TITLEで定義されます。 設定およびメンテナンス作業領域および標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- SupplierRegistrationContactId; 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のデフォルト・バージョンを選択します。
ルート・スキーマ : supplierRegistrationRequests-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"の場合、推定行数は含まれません。
ネストされたスキーマ : supplierRegistrationRequests-contacts-item-response
タイプ:
ソースを表示
object
-
AdministrativeContactFlag: boolean
最大長:
1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サプライヤは管理担当者です。 falseの場合、サプライヤは管理contact.Theのデフォルト値ではなくfalseです。 -
CreateUserAccountFlag: boolean
最大長:
1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サプライヤ担当のユーザー・アカウントを作成します。 falseの場合、サプライヤ担当のユーザー・アカウントは作成しないでください。 デフォルト値はfalseです。 -
DFF: array DFF
-
Email: string
タイトル:
Email
最大長:320
登録内のサプライヤ担当者のEメール。 -
FaxAreaCode: string
タイトル:
Fax Area Code
最大長:10
サプライヤ登録のサプライヤ担当のFAX番号の領域を識別する略称です。 -
FaxCountryCode: string
タイトル:
Fax Country Code
最大長:10
サプライヤ登録のサプライヤ担当のFAX番号の国を識別する略称です。 -
FaxNumber: string
タイトル:
Fax
最大長:40
サプライヤ登録のサプライヤ担当のFAX番号。 -
FirstName: string
タイトル:
First Name
最大長:150
サプライヤ登録のサプライヤ担当者の名です。 -
JobTitle: string
タイトル:
Job Title
最大長:100
サプライヤ登録のサプライヤ担当のジョブ・タイトル。 -
LastName: string
タイトル:
Last Name
最大長:150
サプライヤ登録のサプライヤ担当の姓。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MiddleName: string
タイトル:
Middle Name
最大長:60
サプライヤ登録のサプライヤ担当のミドル・ネームです。 -
MobileAreaCode: string
タイトル:
Mobile Area Code
最大長:10
サプライヤ登録のサプライヤ担当の携帯電話番号のエリアを識別する略称です。 -
MobileCountryCode: string
タイトル:
Mobile Country Code
最大長:10
サプライヤ登録のサプライヤ担当の携帯電話番号の国を識別する略称です。 -
MobileNumber: string
タイトル:
Mobile
最大長:40
サプライヤ登録のサプライヤ担当の携帯電話番号。 -
PhoneAreaCode: string
タイトル:
Phone Area Code
最大長:10
サプライヤ登録におけるサプライヤ担当者の地線電話番号の市区町村を識別する略称です。 -
PhoneCountryCode: string
タイトル:
Phone Country Code
最大長:10
サプライヤ登録におけるサプライヤ担当者の地線電話番号の国を識別する略称です。 -
PhoneExtension: string
タイトル:
Phone Extension
最大長:20
サプライヤ登録のサプライヤ担当の電話内線内線番号です。 -
PhoneNumber: string
タイトル:
Phone
最大長:40
サプライヤ登録におけるサプライヤ担当のランド・ライン電話番号です。 -
roles: array Roles
タイトル:
Roles
ロール・リソースは、サプライヤ登録のサプライヤ担当のユーザー・アカウント・ロールを管理します。 -
Salutation: string
最大長:
80
サプライヤ登録のサプライヤ担当者の敬称です。 -
SalutationCode: string
タイトル:
Salutation
最大長:30
サプライヤ登録のサプライヤ担当の敬称を識別する略称です。 使用可能な値のリストは、参照タイプCONTACT_TITLEで定義されます。 設定およびメンテナンス作業領域および標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
SupplierRegistrationContactId: integer (int64)
サプライヤ登録のサプライヤ担当を一意に識別する値。
ネストされたスキーマ : supplierRegistrationRequests-contacts-DFF-item-response
タイプ:
ソースを表示
object
-
__FLEX_Context: string
タイトル:
Enter Person Information
最大長:30
-
__FLEX_Context_DisplayValue: string
タイトル:
Enter Person Information
-
ContactRequestId: integer (int64)
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : supplierRegistrationRequests-contacts-roles-item-response
タイプ:
ソースを表示
object
-
Description: string
タイトル:
Description
読取り専用:true
最大長:240
サプライヤ・ユーザー・ロールの摘要。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
RoleId: integer
サプライヤ・ユーザー・ロールの一意の識別子です。
-
RoleName: string
最大長:
255
サプライヤ・ユーザー・ロールの名前。 -
SupplierRegistrationContactRoleId: integer (int64)
サプライヤ登録のサプライヤ担当者に関連付けられたロールを一意に識別する値。