機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. サービス・リクエスト
  4. マイルストン

すべてのサービス・リクエスト・マイルストンの取得

get

/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srMilestone

リクエスト

パス・パラメータ
  • サービス・リクエストの識別に使用される一意の番号。 サービス・リクエスト番号は、組織の要件に最適な形式に構成できます。 たとえば、サービス・リクエストには、要件に応じて、サービスrequest0000012345、サービスrequest_000_12345、12345_00_serviceリクエストなどのフォーマットを設定できます。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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 : マイルストンID別にサービス・リクエスト・マイルストンを検索します。
      ファインダ変数:
      • SrMilestoneId; integer;サービス・リクエスト・マイルストンID。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • ActiveFlag; boolean;マイルストーンがアクティブであることを示します。
    • AgentCompletedFlag; boolean;エージェントがマイルストンを完了としてマークしたかどうかを示します。
    • AllowAgentCompletionFlag; boolean。エージェントがマイルストンを完了としてマークできるかどうかを示します。
    • AllowDueDateOverrideFlag; boolean;エージェントがマイルストンの期日を上書きできるかどうかを示します。
    • コメント、文字列。エージェントがマイルストンについて行ったコメント。 たとえば、期日が上書きされた理由です。
    • CompletionDate; string;マイルストーンが完了した日付。
    • ComplianceFlag; boolean;マイルストンが準拠しているかどうかを示します。 デフォルト値はtrueです。
    • 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;マイルストンのステータスを示すコード。 受け入れられる値のリストは、参照ORA_SVC_MILESTONE_STATUS_CDで定義されます。
    • MilestoneStatusCdMeaning; string;マイルストンのステータス参照コードに対応する表示値。
    • PauseConditionLabel; string;一時停止時のマイルストンの条件。
    • SrAssigneePartyId; integer; サービス・リクエストに割り当てられたリソースの一意の識別子。
    • SrId; integer; サービス・リクエストの一意の識別子。
    • SrMilestoneId; integer;マイルストンの一意の識別子。
    • StartConditionLabel; string;開始時のマイルストンの条件。
    • SubscriptionCoveragePuid;文字列;サブスクリプション・カバレッジPUID
    • SubscriptionNumber;文字列;サブスクリプション番号
    • TimeLeftOnceUnpaused; integer; サービス・リクエストが一時停止状態からリストアされた後にマイルストンを完了するまでの残り時間。
    • TimeRemaining; string;マイルストンの残り時間。
    • WarnedFlag; boolean;マイルストンが警告しきい値を超えたかどうかを示します。
    • WarningDate; string;マイルストンが警告しきい値を渡した日時。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : serviceRequests-srMilestone
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : serviceRequests-srMilestone-item-response
タイプ: object
ソースを表示
  • タイトル: Active
    最大長: 1
    デフォルト値: false
    マイルストンがアクティブであることを示します。
  • タイトル: Agent Completed
    最大長: 1
    デフォルト値: false
    エージェントがマイルストンを完了としてマークしたかどうかを示します。
  • タイトル: Allow Agent Completion
    読取り専用: true
    最大長: 1
    デフォルト値: false
    エージェントがマイルストンを完了としてマークできるかどうかを示します。
  • タイトル: Allow Due Date Override
    読取り専用: true
    最大長: 1
    デフォルト値: false
    エージェントがマイルストン期日を上書きできるかどうかを示します。
  • タイトル: Comments
    最大長: 400
    マイルストンについてエージェントが行ったコメント。 たとえば、期日が上書きされた理由です。
  • タイトル: Completion Date
    マイルストンが完了した日付。
  • タイトル: Compliance
    最大長: 1
    デフォルト値: true
    マイルストンが準拠しているかどうかを示します。 デフォルト値はtrueです。
  • タイトル: Coverage ID
    サービス・リクエスト・カバレッジの一意の識別子。
  • タイトル: Coverage Source
    最大長: 120
    補償内容ソース
  • タイトル: Coverage Source
    読取り専用: true
    カバレッジ・ソース参照コードに対応する表示値。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    マイルストンを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    マイルストンが作成された日時。
  • タイトル: Delay Time
    マイルストンが期日から遅延した時間。
  • タイトル: Can Delete
    読取り専用: true
    マイルストンが削除されたかどうかを示します。
  • マイルストンの期日。
  • マイルストンの資格/権利の一意の識別子。
  • タイトル: Last Updated Date
    読取り専用: true
    マイルストンが最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    マイルストンを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    マイルストンを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Milestone Configuration ID
    マイルストン構成の一意の識別子。
  • タイトル: Name
    読取り専用: true
    最大長: 255
    マイルストンの表示名。
  • タイトル: Status
    最大長: 30
    マイルストンのステータスを示すコード。 受け入れられる値のリストは、参照ORA_SVC_MILESTONE_STATUS_CDで定義されます。
  • タイトル: Milestone Status
    読取り専用: true
    最大長: 255
    マイルストンのステータス参照コードに対応する表示値。
  • タイトル: Pauses When
    読取り専用: true
    最大長: 1000
    一時停止時のマイルストンの条件。
  • タイトル: Assigned to Party ID
    サービス・リクエストに割り当てられたリソースの一意の識別子。
  • タイトル: Service Request ID
    サービス・リクエストの一意の識別子。
  • Milestone Codes
    タイトル: Milestone Codes
    マイルストン・コード・リソースは、マイルストン・トラッキングが開始、一時停止、完了としてマークされた時間または再起動された時間エントリのリストなど、サービス・リクエストのマイルストン・ステータスの変更の履歴を表示、作成、更新および削除するために使用されます。
  • タイトル: Milestone ID
    読取り専用: true
    マイルストンの一意の識別子。
  • タイトル: Starts When
    読取り専用: true
    最大長: 1000
    マイルストンの開始時の条件。
  • タイトル: Subscription Coverage PUID
    最大長: 120
    サブスクリプション・カバレッジPUID
  • タイトル: Subscription Number
    最大長: 120
    サブスクリプション番号
  • タイトル: Paused Minutes Remaining
    サービス・リクエストが一時停止状態からリストアされた後、マイルストンの完了までの残り時間。
  • タイトル: Time Remaining
    読取り専用: true
    マイルストンの残り時間。
  • タイトル: Can Update
    読取り専用: true
    マイルストンが更新されたかどうかを示します。
  • タイトル: Warned
    最大長: 1
    デフォルト値: false
    マイルストンが警告しきい値を超えたかどうかを示します。
  • タイトル: Warning Date
    マイルストンが警告しきい値を渡した日時。
ネストされたスキーマ : マイルストン・コード
タイプ: array
タイトル: Milestone Codes
マイルストン・コード・リソースは、マイルストン・トラッキングが開始、一時停止、完了としてマークされた時間または再起動された時間エントリのリストなど、サービス・リクエストのマイルストン・ステータスの変更の履歴を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : serviceRequests-srMilestone-SrMilestoneHistory-item-response
タイプ: object
ソースを表示
  • タイトル: Accumulated Time
    サービス・リクエスト・マイルストンがステータスに費やした合計時間。
  • タイトル: Description
    最大長: 400
    マイルストンについてエージェントが行ったコメント。 たとえば、期日が上書きされた理由です。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    マイルストンを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    マイルストンが作成された日時。
  • マイルストンがステータスを終了した日時。
  • タイトル: History ID
    読取り専用: true
    マイルストン履歴の一意の識別子。
  • タイトル: Last Updated Date
    読取り専用: true
    ミル・ストーン履歴が最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    マイルストン履歴を最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    マイルストン履歴を最後に更新したユーザーのログイン。
  • Links
  • タイトル: Status
    最大長: 30
    マイルストンのステータスを示すコード。 受け入れられる値のリストは、参照ORA_SVC_MILESTONE_STATUS_CDで定義されます。
  • タイトル: Due Date
    エージェントがマイルストンに対して設定した新規期日を示します。
  • タイトル: Milestone ID
    サービス・リクエスト・マイルストンの一意の識別子。
  • タイトル: Date
    マイルストン・ステータスが変更された日時。
トップに戻る

例:

次の例は、RESTリソースに対してGETリクエストを発行して、すべてのサービス・リクエスト・マイルストンを取得する方法を示しています。

リクエスト・ヘッダーの例

次に、リクエスト・ヘッダーの例を示します。

GET /crmRestApi/resources/11.13.18.05/serviceRequests/SR0000011577/child/srMilestone 
HOST: servername.fa.us2.oraclecloud.com
authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE=
content-type: application/vnd.oracle.adf.resourceitem+json

レスポンス・ヘッダーの例

次に、レスポンス・ヘッダーの例を示します。

HTTP/1.1 200 OK
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

レスポンス本文の例

次の例は、レスポンス本文の内容を示しています。

{
  "items": [
    {
      "ActiveFlag": true,
      "CompletionDate": null,
      "ComplianceFlag": true,
      "CreatedBy": "CUSTOMER_SERVICE_MANAGER",
      "CreationDate": "2017-04-21T08:46:39.014+00:00",
      "DueDate": "2017-04-21T09:16:00+00:00",
      "LastUpdateDate": "2017-04-21T08:46:39.204+00:00",
      "LastUpdateLogin": "4DA98A89E4F44291E05356C0F20A8E01",
      "LastUpdatedBy": "CUSTOMER_SERVICE_MANAGER",
      "MilestoneStatusCd": "ORA_SVC_IN_PROGRESS",
      "SrId": 300100114883796,
      "SrMilestoneId": 300100114883833,
      "WarnedFlag": false,
      "WarningDate": "2017-04-21T08:51:00+00:00",
      "EntitlementId": -1,
      "CoverageId": 300100091977325,
      "MilestoneConfigId": 100100052668202,
      "MilestoneLabel": "First Response Metric",
      "StartConditionLabel": "New",
      "PauseConditionLabel": "Never",
      "TimeRemaining": "20 Minutes late",
      "DelayTime": null,
      "SrAssigneePartyId": null,
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000011577/child/srMilestone/300100114883833",
          "name": "srMilestone",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000011577/child/srMilestone/300100114883833",
          "name": "srMilestone",
          "kind": "item"
        },
        {
          "rel": "parent",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000011577",
          "name": "serviceRequests",
          "kind": "item"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000011577/child/srMilestone/300100114883833/lov/Yes_NoLookup",
          "name": "Yes_NoLookup",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000011577/child/srMilestone/300100114883833/lov/Milestone_StatusCdLookup",
          "name": "Milestone_StatusCdLookup",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000011577/child/srMilestone/300100114883833/child/SrMilestoneHistory",
          "name": "SrMilestoneHistory",
          "kind": "collection"
        }
      ]
    },
    {
      "ActiveFlag": true,
      "CompletionDate": null,
      "ComplianceFlag": true,
      "CreatedBy": "CUSTOMER_SERVICE_MANAGER",
      "CreationDate": "2017-04-21T08:46:39.119+00:00",
      "DueDate": "2017-04-21T09:46:00+00:00",
      "LastUpdateDate": "2017-04-21T08:46:39.206+00:00",
      "LastUpdateLogin": "4DA98A89E4F44291E05356C0F20A8E01",
      "LastUpdatedBy": "CUSTOMER_SERVICE_MANAGER",
      "MilestoneStatusCd": "ORA_SVC_IN_PROGRESS",
      "SrId": 300100114883796,
      "SrMilestoneId": 300100114883836,
      "WarnedFlag": false,
      "WarningDate": "2017-04-21T08:56:00+00:00",
      "EntitlementId": -1,
      "CoverageId": 300100091977325,
      "MilestoneConfigId": 100100052668206,
      "MilestoneLabel": "Resolution Metric",
      "StartConditionLabel": "Service Request is created.",
      "PauseConditionLabel": "SR status type \"Waiting\"",
      "TimeRemaining": "9 Minutes",
      "DelayTime": null,
      "SrAssigneePartyId": null,
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000011577/child/srMilestone/300100114883836",
          "name": "srMilestone",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000011577/child/srMilestone/300100114883836",
          "name": "srMilestone",
          "kind": "item"
        },
        {
          "rel": "parent",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000011577",
          "name": "serviceRequests",
          "kind": "item"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000011577/child/srMilestone/300100114883836/lov/Yes_NoLookup",
          "name": "Yes_NoLookup",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000011577/child/srMilestone/300100114883836/lov/Milestone_StatusCdLookup",
          "name": "Milestone_StatusCdLookup",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000011577/child/srMilestone/300100114883836/child/SrMilestoneHistory",
          "name": "SrMilestoneHistory",
          "kind": "collection"
        }
      ]
    }
  ],
  "count": 2,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000011577/child/srMilestone",
      "name": "srMilestone",
      "kind": "collection"
    }
  ]
}
「トップに戻る」