すべてのノートの取得
get
/crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Note
リクエスト
パス・パラメータ
- FundRequestCode(required): string
MDFリクエストのユーザー定義の一意のラベルを示すコード。
問合せパラメータ
- 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 : 指定された主キー識別子を持つノートを検索します。
ファインダ変数:- NoteId; 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;Loc!=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- ContactRelationshipId; integer;関係の一意の識別子。ノートがMDFリクエスト・ユーザーに関連付けられている場合に移入されます。
- CreatedBy; string; ノート・レコードを作成したユーザー。
- CreationDate; string; ノート・レコードが作成された日時。
- CreatorPartyId; integer; ノートを作成したパーティの一意の識別子。
- EmailAddress; string; ノートを作成したユーザーの電子メール・アドレス。
- LastUpdateDate; string; ノート・データが最後に更新された日時。
- LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
- LastUpdatedBy; string; レコードを最後に更新したユーザー。
- NoteId; integer; MDFリクエストに関連付けられたノートの一意の識別子これは、ノート表の主キーです。
- NoteNumber; string; ノートの代替の一意の識別子。 システム生成または外部システムからのユーザー・キー。
- NoteTitle; string; ユーザーが入力したノートのタイトル。
- NoteTxt; string; 実際のノート・テキストを格納する列。
- NoteTypeCode; string; ノートのタイプを示すコード。
- ParentNoteId; integer; 親ノートの一意の識別子。
- PartyId; integer; ノートが関連付けられているMDFリクエストの一意の識別子。
- PartyName; string; MDFリクエスト・パーティの名前。
- SourceObjectCode; string; OBJECTS Metadataで定義されているソース・オブジェクトのコード。
- SourceObjectId; string; OBJECTS Metadataで定義されているソース・オブジェクトの一意の識別子。
- VisibilityCode; string; 内部や外部など、ノートの表示レベルを示すコード。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : mdfRequests-Note
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : mdfRequests-Note-item-response
タイプ:
ソースを表示
object
-
ContactRelationshipId: integer (int64)
タイトル:
Contact Relationship ID
関係の一意の識別子であり、ノートがMDFリクエスト・ユーザーに関連付けられているときに移入されます。 -
CorpCurrencyCode: string
タイトル:
Corporate Currency Code
最大長:15
MDFリクエストに関連付けられたノートの企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
ノート・レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
ノート・レコードが作成された日時。 -
CreatorPartyId: integer (int64)
タイトル:
Creator Party ID
ノートを作成したパーティの一意の識別子。 -
CurcyConvRateType: string
タイトル:
Currency Conversion Rate Type
最大長:30
ノートに関連付けられた通貨換算レート・タイプ受け入れられる値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
CurrencyCode: string
タイトル:
Currency
最大長:15
ノートに関連付けられた通貨コード受け入れられる値のリストは参照で定義されますZCA_COMMON_CORPORATE_CURRENCY「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
DeleteFlag: boolean
タイトル:
Delete Indicator
読取り専用:true
ノートを削除するかどうかを示します。 値がYの場合、ノートを削除する必要があります。 デフォルト値はNです。 -
EmailAddress: string
タイトル:
Primary Email
読取り専用:true
最大長:320
ノートを作成したユーザーのEメール・アドレス。 -
FormattedAddress: string
タイトル:
Primary Address
読取り専用:true
ノートを作成したユーザーのプライマリ住所。 -
FormattedPhoneNumber: string
タイトル:
Primary Phone
読取り専用:true
ノートを作成したユーザーのプライマリ電話番号。 -
LastUpdateDate: string (date-time)
タイトル:
Last Update Date
読取り専用:true
ノート・データが最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
レコードを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
NoteId: integer (int64)
タイトル:
Note ID
読取り専用:true
MDFリクエストに関連付けられたノートの一意の識別子。これはノート表の主キーです。 -
NoteNumber: string
最大長:
30
ノートの代替一意識別子。 システム生成または外部システムからのユーザー・キー。 -
NoteTitle: string
タイトル:
Title
最大長:500
ユーザーが入力したノートのタイトル。 -
NoteTxt: 文字列(バイト)
タイトル:
Note
実際のノート・テキストを保存する列。 -
NoteTypeCode: string
タイトル:
Type
最大長:30
ノートのタイプを示すコード。 -
ParentNoteId: integer (int64)
タイトル:
Parent Note ID
親ノートの一意の識別子。 -
PartyId: integer (int64)
タイトル:
Party ID
読取り専用:true
ノートが関連付けられているMDFリクエストの一意の識別子。 -
PartyName: string
タイトル:
Author
読取り専用:true
最大長:360
MDFリクエスト・パーティの名前。 -
SourceObjectCode: string
タイトル:
Related Object Type
最大長:30
OBJECTS Metadataで定義されたソース・オブジェクトのコード。 -
SourceObjectId: string
タイトル:
Related Object
最大長:64
OBJECTS Metadataで定義されたソース・オブジェクトの一意の識別子。 -
UpdateFlag: boolean
タイトル:
Update Indicator
読取り専用:true
ノートを更新できるかどうかを示します。 値がYの場合は、ノートを更新できます。 デフォルト値はNです。 -
VisibilityCode: string
タイトル:
Private
最大長:30
デフォルト値:INTERNAL
内部や外部など、ノートの表示レベルを示すコード。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。