すべてのサービス・リクエスト・マイルストンの取得
get
/crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srMilestone
リクエスト
パス・パラメータ
- SrId(required): integer(int64)
このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: 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
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- PrimaryKey :指定した主キーでサービス・リクエスト・マイルストンを検索します。
ファインダ変数:- SrMilestoneId :サービス・リクエスト・マイルストンの一意の識別子。
- 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- ActiveFlag; boolean。サービス・リクエスト・マイルストンがアクティブかどうかを示します。
- AgentCompletedFlag; boolean;エージェントがマイルストンを完了としてマークしたかどうかを示します。
- AllowAgentCompletionFlag; boolean。エージェントがマイルストンを完了としてマークできるかどうかを示します。
- AllowDueDateOverrideFlag; boolean;エージェントがマイルストンの期日を上書きできるかどうかを示します。
- コメント、文字列。顧客またはエージェントのコメント。
- CompletionDate; string;マイルストーンが完了する日付。
- ComplianceFlag; boolean;マイルストンのコンプライアンス・ステータス。
- CoverageId; integer; カバレッジ・レコードの一意の識別子。
- CoverageSourceCd;文字列;カバレッジ・ソース
- CoverageSourceCdMeaning; string;カバレッジ・ソース参照コードに対応する表示値。
- CreatedBy; string;マイルストンを作成したユーザー。
- CreationDate; string; レコードが作成された日時。
- DelayTime; integer;期日と完了日の間の時間。
- DueDate; string;マイルストンの期日。
- LastUpdateDate; string; レコードが最後に更新された日時。
- LastUpdateLogin; string;マイルストンを最後に更新したユーザーのログイン。
- LastUpdatedBy; string;マイルストンを最後に更新したユーザー。
- MilestoneConfigId; integer;マイルストン構成レコードの一意の識別子。
- MilestoneLabel; string;マイルストンの名前。
- MilestoneStatusCd; string;マイルストンのステータス。
- MilestoneStatusCdMeaning; string;マイルストンのステータス参照コードに対応する表示値。
- PauseConditionLabel; string;マイルストンが一時停止する時間。
- SrAssigneePartyId; integer; サービス・リクエスト割当先の一意のパーティ・オブジェクト識別子。
- SrId; integer; サービス・リクエスト・レコードの一意の識別子。
- SrMilestoneId; integer;サービス・リクエスト・マイルストン・レコードの一意の識別子。
- StartConditionLabel; string;マイルストンの開始時間。
- SubscriptionCoveragePuid;文字列;サブスクリプション・カバレッジPUID
- SubscriptionNumber;文字列;サブスクリプション番号
- TimeLeftOnceUnpaused; integer;マイルストンが一時停止状態からリストアされた後に完了するまでの残り時間(分)。
- TimeRemaining; string;マイルストンの残り時間。
- WarnedFlag; boolean;マイルストンが警告しきい値を渡したかどうかを示します。
- WarningDate; 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のデフォルト・バージョンを選択します。
ルート・スキーマ : internalServiceRequests-srMilestone
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : internalServiceRequests-srMilestone-item-response
タイプ:
ソースを表示
object
-
ActiveFlag: boolean
タイトル:
Active
最大長:1
デフォルト値:false
サービス・リクエスト・マイルストンがアクティブかどうかを示します。 -
AgentCompletedFlag: boolean
タイトル:
Agent Completed
最大長:1
デフォルト値:false
エージェントがマイルストンを完了としてマークしたかどうかを示します。 -
AllowAgentCompletionFlag: boolean
タイトル:
Allow Agent Completion
読取り専用:true
最大長:1
デフォルト値:false
エージェントがマイルストンを完了としてマークできるかどうかを示します。 -
AllowDueDateOverrideFlag: boolean
タイトル:
Allow Due Date Override
読取り専用:true
最大長:1
デフォルト値:false
エージェントがマイルストン期日を上書きできるかどうかを示します。 -
Comments: string
タイトル:
Comments
最大長:400
顧客またはエージェントのコメント。 -
CompletionDate: string (date-time)
タイトル:
Completion Date
マイルストンが完了する日付。 -
ComplianceFlag: boolean
タイトル:
Compliance
最大長:1
デフォルト値:true
マイルストンのコンプライアンス・ステータス。 -
CoverageId: integer (int64)
タイトル:
Coverage ID
カバレッジ・レコードの一意の識別子。 -
CoverageSourceCd: string
タイトル:
Coverage Source
最大長:120
補償内容ソース -
CoverageSourceCdMeaning: string
タイトル:
Coverage Source
読取り専用:true
カバレッジ・ソース参照コードに対応する表示値。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
マイルストンを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日時。 -
DelayTime: integer (int64)
タイトル:
Delay Time
期日と完了日の間の時間。 -
DeleteFlag: boolean
タイトル:
Can Delete
読取り専用:true
レコードを削除するためのアクセス権がユーザーに付与されているかどうかを示します。 -
DueDate: string (date-time)
マイルストンの期日。
-
EntitlementId: integer
資格/権利レコードの一意の識別子。
-
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
レコードが最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
マイルストンを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
マイルストンを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MilestoneConfigId: integer (int64)
タイトル:
Milestone Configuration ID
マイルストン構成レコードの一意の識別子。 -
MilestoneLabel: string
タイトル:
Name
読取り専用:true
最大長:255
マイルストンの名前。 -
MilestoneStatusCd: string
タイトル:
Status
最大長:30
マイルストンのステータス。 -
MilestoneStatusCdMeaning: string
タイトル:
Milestone Status
読取り専用:true
最大長:255
マイルストンのステータス参照コードに対応する表示値。 -
PauseConditionLabel: string
タイトル:
Pauses When
読取り専用:true
最大長:1000
マイルストンが一時停止する時間。 -
SrAssigneePartyId: integer
タイトル:
Assigned to Party ID
サービス・リクエスト割当先の一意のパーティ・オブジェクト識別子。 -
SrId: integer (int64)
タイトル:
Service Request ID
サービス・リクエスト・レコードの一意の識別子。 -
SrMilestoneHistory: array Milestones History
タイトル:
Milestones History
サービス・リクエスト・マイルストン・ステータスの変更のリスト。 -
SrMilestoneId: integer (int64)
タイトル:
Milestone ID
読取り専用:true
サービス・リクエスト・マイルストン・レコードの一意の識別子。 -
StartConditionLabel: string
タイトル:
Starts When
読取り専用:true
最大長:1000
マイルストンの開始時間。 -
SubscriptionCoveragePuid: string
タイトル:
Subscription Coverage PUID
最大長:120
サブスクリプション・カバレッジPUID -
SubscriptionNumber: string
タイトル:
Subscription Number
最大長:120
サブスクリプション番号 -
TimeLeftOnceUnpaused: integer
タイトル:
Paused Minutes Remaining
マイルストーンが一時停止状態からリストアされた後に完了する残り時間(分)。 -
TimeRemaining: string
タイトル:
Time Remaining
読取り専用:true
マイルストンの残り時間。 -
UpdateFlag: boolean
タイトル:
Can Update
読取り専用:true
レコードを更新するためのアクセス権がユーザーに付与されているかどうかを示します。 -
WarnedFlag: boolean
タイトル:
Warned
最大長:1
デフォルト値:false
マイルストンが警告しきい値を渡したかどうかを示します。 -
WarningDate: string (date-time)
タイトル:
Warning Date
マイルストンが警告しきい値を渡した日時。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
ネストされたスキーマ : internalServiceRequests-srMilestone-SrMilestoneHistory-item-response
タイプ:
ソースを表示
object
-
AccumulatedTimeInStatus: integer (int64)
タイトル:
Accumulated Time
サービス・リクエスト・マイルストンがステータスに費やした合計時間。 -
Comments: string
タイトル:
Description
最大長:400
エージェントのコメント。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日時。 -
EndTime: string (date-time)
マイルストンがステータスを終了した日時。
-
HistoryId: integer (int64)
タイトル:
History ID
読取り専用:true
マイルストン履歴レコードの一意の識別子。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
レコードが最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
マイルストン履歴を最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
マイルストン履歴を最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MilestoneStatusCd: string
タイトル:
Status
最大長:30
マイルストンのステータス。 -
OverriddenDueDate: string (date-time)
タイトル:
Due Date
マイルストン上書き期限。 -
SrMilestoneId: integer (int64)
タイトル:
Milestone ID
サービス・リクエスト・マイルストン・レコードの一意の識別子。 -
StartTime: string (date-time)
タイトル:
Date
マイルストン・ステータスが変更された日時。