機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

サービス・リクエスト・マイルストンの更新

patch

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

リクエスト

パス・パラメータ

• SrMilestoneId(required): integer(int64)
  マイルストンの一意の識別子。
• SrNumber(required): string
  サービス・リクエストの識別に使用される一意の番号。 サービス・リクエスト番号は、組織の要件に最適な形式に構成できます。 たとえば、サービス・リクエストには、要件に応じて、サービスrequest0000012345、サービスrequest_000_12345、12345_00_serviceリクエストなどのフォーマットを設定できます。

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

• application/json

リクエスト本文 - application/json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• ActiveFlag: boolean
  タイトル: Active

  最大長: 1

  デフォルト値: false

  マイルストンがアクティブであることを示します。
• AgentCompletedFlag: boolean
  タイトル: Agent Completed

  最大長: 1

  デフォルト値: false

  エージェントがマイルストンを完了としてマークしたかどうかを示します。
• Comments: string
  タイトル: Comments

  最大長: 400

  マイルストンについてエージェントが行ったコメント。 たとえば、期日が上書きされた理由です。
• CompletionDate: string (date-time)
  タイトル: Completion Date

  マイルストンが完了した日付。
• ComplianceFlag: boolean
  タイトル: Compliance

  最大長: 1

  デフォルト値: true

  マイルストンが準拠しているかどうかを示します。 デフォルト値はtrueです。
• CoverageSourceCd: string
  タイトル: Coverage Source

  最大長: 120

  補償内容ソース
• DelayTime: integer (int64)
  タイトル: Delay Time

  マイルストンが期日から遅延した時間。
• DueDate: string (date-time)
  マイルストンの期日。
• EntitlementId: integer
  マイルストンの資格/権利の一意の識別子。
• MilestoneStatusCd: string
  タイトル: Status

  最大長: 30

  マイルストンのステータスを示すコード。 受け入れられる値のリストは、参照ORA_SVC_MILESTONE_STATUS_CDで定義されます。
• SrAssigneePartyId: integer
  タイトル: Assigned to Party ID

  サービス・リクエストに割り当てられたリソースの一意の識別子。
• SrMilestoneHistory: array Milestone Codes
  タイトル: Milestone Codes

  マイルストン・コード・リソースは、マイルストン・トラッキングが開始、一時停止、完了としてマークされた時間または再起動された時間エントリのリストなど、サービス・リクエストのマイルストン・ステータスの変更の履歴を表示、作成、更新および削除するために使用されます。
• SubscriptionNumber: string
  タイトル: Subscription Number

  最大長: 120

  サブスクリプション番号
• TimeLeftOnceUnpaused: integer
  タイトル: Paused Minutes Remaining

  サービス・リクエストが一時停止状態からリストアされた後、マイルストンの完了までの残り時間。
• WarnedFlag: boolean
  タイトル: Warned

  最大長: 1

  デフォルト値: false

  マイルストンが警告しきい値を超えたかどうかを示します。
• WarningDate: string (date-time)
  タイトル: Warning Date

  マイルストンが警告しきい値を渡した日時。

{
    "type":"object",
    "properties":{
        "MilestoneStatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the milestone. A list of accepted values is defined in the lookup ORA_SVC_MILESTONE_STATUS_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WarnedFlag":{
            "title":"Warned",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the milestone has passed the warning threshold.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":120,
            "type":"string",
            "description":"Subscription Number",
            "nullable":true
        },
        "SrAssigneePartyId":{
            "title":"Assigned to Party ID",
            "type":"integer",
            "description":"The unique identifier of the resource assigned to the service request.",
            "nullable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":400,
            "type":"string",
            "description":"The comments the agent made about the milestone. For example, why the due date was overridden.",
            "nullable":true
        },
        "EntitlementId":{
            "type":"integer",
            "description":"The unique identifier of the entitlement for the milestone.",
            "nullable":true,
            "x-queryable":false
        },
        "TimeLeftOnceUnpaused":{
            "title":"Paused Minutes Remaining",
            "type":"integer",
            "description":"The time left to complete the milestone after the service request is restored from a paused state.",
            "nullable":true
        },
        "DelayTime":{
            "title":"Delay Time",
            "type":"integer",
            "description":"The amount of time the milestones has been delayed from the due date.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SrMilestoneHistory":{
            "title":"Milestone Codes",
            "type":"array",
            "description":"The milestone codes resource is used to view, create, update, and delete the history of changes in the milestone status of a service request, such as a list of time entries for when the milestone tracking is started, paused, marked as complete, or restarted.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-srMilestone-SrMilestoneHistory-item-patch-request"
            }
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the milestone is active.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "CoverageSourceCd":{
            "title":"Coverage Source",
            "maxLength":120,
            "type":"string",
            "description":"Coverage Source",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DueDate":{
            "type":"string",
            "description":"The date when the milestone is due.",
            "format":"date-time",
            "nullable":true
        },
        "WarningDate":{
            "title":"Warning Date",
            "type":"string",
            "description":"The date and time when the milestone passed the warning threshold.",
            "format":"date-time",
            "nullable":true
        },
        "CompletionDate":{
            "title":"Completion Date",
            "type":"string",
            "description":"The date when the milestone was completed.",
            "format":"date-time",
            "nullable":true
        },
        "ComplianceFlag":{
            "title":"Compliance",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the milestone is compliant or not. The default value is true.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "AgentCompletedFlag":{
            "title":"Agent Completed",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether agent marked the milestone as complete.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        }
    }
}

ネストされたスキーマ : マイルストン・コード

タイプ: array

タイトル: Milestone Codes

マイルストン・コード・リソースは、マイルストン・トラッキングが開始、一時停止、完了としてマークされた時間または再起動された時間エントリのリストなど、サービス・リクエストのマイルストン・ステータスの変更の履歴を表示、作成、更新および削除するために使用されます。

ソースを表示

• Array of: object serviceRequests-srMilestone-SrMilestoneHistory-item-patch-request

{
    "title":"Milestone Codes",
    "type":"array",
    "description":"The milestone codes resource is used to view, create, update, and delete the history of changes in the milestone status of a service request, such as a list of time entries for when the milestone tracking is started, paused, marked as complete, or restarted.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-srMilestone-SrMilestoneHistory-item-patch-request"
    }
}

ネストされたスキーマ : serviceRequests-srMilestone-SrMilestoneHistory-item-patch-request

タイプ: object

ソースを表示

• AccumulatedTimeInStatus: integer (int64)
  タイトル: Accumulated Time

  サービス・リクエスト・マイルストンがステータスに費やした合計時間。
• Comments: string
  タイトル: Description

  最大長: 400

  マイルストンについてエージェントが行ったコメント。 たとえば、期日が上書きされた理由です。
• EndTime: string (date-time)
  マイルストンがステータスを終了した日時。
• MilestoneStatusCd: string
  タイトル: Status

  最大長: 30

  マイルストンのステータスを示すコード。 受け入れられる値のリストは、参照ORA_SVC_MILESTONE_STATUS_CDで定義されます。
• OverriddenDueDate: string (date-time)
  タイトル: Due Date

  エージェントがマイルストンに対して設定した新規期日を示します。
• SrMilestoneId: integer (int64)
  タイトル: Milestone ID

  サービス・リクエスト・マイルストンの一意の識別子。
• StartTime: string (date-time)
  タイトル: Date

  マイルストン・ステータスが変更された日時。

{
    "type":"object",
    "properties":{
        "MilestoneStatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the milestone. A list of accepted values is defined in the lookup ORA_SVC_MILESTONE_STATUS_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EndTime":{
            "type":"string",
            "description":"The date and time when the milestone exited the status.",
            "format":"date-time",
            "nullable":true
        },
        "Comments":{
            "title":"Description",
            "maxLength":400,
            "type":"string",
            "description":"The comments the agent made about the milestone. For example, why the due date was overridden.",
            "nullable":true
        },
        "AccumulatedTimeInStatus":{
            "title":"Accumulated Time",
            "type":"integer",
            "description":"The total time the service request milestone spent in the status.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "StartTime":{
            "title":"Date",
            "type":"string",
            "description":"The date and time when the milestone status was changed.",
            "format":"date-time",
            "nullable":false
        },
        "OverriddenDueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"Indicates the new due date the agent set for the milestone.",
            "format":"date-time",
            "nullable":true
        },
        "SrMilestoneId":{
            "title":"Milestone ID",
            "type":"integer",
            "description":"The unique identifier of the service request milestone.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

• Metadata-Context(required):
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : serviceRequests-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

  マイルストンが準拠しているかどうかを示します。 デフォルト値は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

  マイルストンのステータスを示すコード。 受け入れられる値のリストは、参照ORA_SVC_MILESTONE_STATUS_CDで定義されます。
• 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 Milestone Codes
  タイトル: Milestone Codes

  マイルストン・コード・リソースは、マイルストン・トラッキングが開始、一時停止、完了としてマークされた時間または再起動された時間エントリのリストなど、サービス・リクエストのマイルストン・ステータスの変更の履歴を表示、作成、更新および削除するために使用されます。
• 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

  マイルストンが警告しきい値を渡した日時。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the milestone was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WarnedFlag":{
            "title":"Warned",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the milestone has passed the warning threshold.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "StartConditionLabel":{
            "title":"Starts When",
            "maxLength":1000,
            "type":"string",
            "description":"The condition of the milestone when it starts.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EntitlementId":{
            "type":"integer",
            "description":"The unique identifier of the entitlement for the milestone.",
            "nullable":true,
            "x-queryable":false
        },
        "MilestoneStatusCdMeaning":{
            "title":"Milestone Status",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the status lookup code for the milestone.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "MilestoneStatusCd"
                ]
            },
            "x-queryable":true
        },
        "TimeLeftOnceUnpaused":{
            "title":"Paused Minutes Remaining",
            "type":"integer",
            "description":"The time left to complete the milestone after the service request is restored from a paused state.",
            "nullable":true,
            "x-queryable":true
        },
        "CoverageSourceCdMeaning":{
            "title":"Coverage Source",
            "type":"string",
            "description":"The display value corresponding to the coverage source lookup code.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CoverageSourceCd"
                ]
            },
            "x-queryable":true
        },
        "SrMilestoneId":{
            "title":"Milestone ID",
            "type":"integer",
            "description":"The unique identifier of the milestone.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AllowAgentCompletionFlag":{
            "title":"Allow Agent Completion",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an agent can mark the milestone as complete.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if the milestone has been updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CoverageId":{
            "title":"Coverage ID",
            "type":"integer",
            "description":"The unique identifier of the service request coverage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AllowDueDateOverrideFlag":{
            "title":"Allow Due Date Override",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an agent can override the milestone due date.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DueDate":{
            "type":"string",
            "description":"The date when the milestone is due.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CompletionDate":{
            "title":"Completion Date",
            "type":"string",
            "description":"The date when the milestone was completed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the milestone.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MilestoneStatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the milestone. A list of accepted values is defined in the lookup ORA_SVC_MILESTONE_STATUS_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MilestoneLabel":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"The display name of the milestone.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the milestone.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":120,
            "type":"string",
            "description":"Subscription Number",
            "nullable":true,
            "x-queryable":true
        },
        "SrAssigneePartyId":{
            "title":"Assigned to Party ID",
            "type":"integer",
            "description":"The unique identifier of the resource assigned to the service request.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":400,
            "type":"string",
            "description":"The comments the agent made about the milestone. For example, why the due date was overridden.",
            "nullable":true,
            "x-queryable":true
        },
        "PauseConditionLabel":{
            "title":"Pauses When",
            "maxLength":1000,
            "type":"string",
            "description":"The condition of the milestone when it pauses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DelayTime":{
            "title":"Delay Time",
            "type":"integer",
            "description":"The amount of time the milestones has been delayed from the due date.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SrMilestoneHistory":{
            "title":"Milestone Codes",
            "type":"array",
            "description":"The milestone codes resource is used to view, create, update, and delete the history of changes in the milestone status of a service request, such as a list of time entries for when the milestone tracking is started, paused, marked as complete, or restarted.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-srMilestone-SrMilestoneHistory-item-response"
            }
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the milestone is active.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the milestone has been deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TimeRemaining":{
            "title":"Time Remaining",
            "type":"string",
            "description":"The time remaining in the milestone.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CoverageSourceCd":{
            "title":"Coverage Source",
            "maxLength":120,
            "type":"string",
            "description":"Coverage Source",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MilestoneConfigId":{
            "title":"Milestone Configuration ID",
            "type":"integer",
            "description":"The unique identifier of the milestone configuration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WarningDate":{
            "title":"Warning Date",
            "type":"string",
            "description":"The date and time when the milestone passed the warning threshold.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ComplianceFlag":{
            "title":"Compliance",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the milestone is compliant or not. The default value is true.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "SubscriptionCoveragePuid":{
            "title":"Subscription Coverage PUID",
            "maxLength":120,
            "type":"string",
            "description":"Subscription Coverage PUID",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the milestone was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the milestone.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgentCompletedFlag":{
            "title":"Agent Completed",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether agent marked the milestone as complete.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : マイルストン・コード

タイプ: array

タイトル: Milestone Codes

マイルストン・コード・リソースは、マイルストン・トラッキングが開始、一時停止、完了としてマークされた時間または再起動された時間エントリのリストなど、サービス・リクエストのマイルストン・ステータスの変更の履歴を表示、作成、更新および削除するために使用されます。

ソースを表示

• Array of: object serviceRequests-srMilestone-SrMilestoneHistory-item-response

{
    "title":"Milestone Codes",
    "type":"array",
    "description":"The milestone codes resource is used to view, create, update, and delete the history of changes in the milestone status of a service request, such as a list of time entries for when the milestone tracking is started, paused, marked as complete, or restarted.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-srMilestone-SrMilestoneHistory-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

ネストされたスキーマ : serviceRequests-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

  マイルストンのステータスを示すコード。 受け入れられる値のリストは、参照ORA_SVC_MILESTONE_STATUS_CDで定義されます。
• OverriddenDueDate: string (date-time)
  タイトル: Due Date

  エージェントがマイルストンに対して設定した新規期日を示します。
• SrMilestoneId: integer (int64)
  タイトル: Milestone ID

  サービス・リクエスト・マイルストンの一意の識別子。
• StartTime: string (date-time)
  タイトル: Date

  マイルストン・ステータスが変更された日時。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the milestone history.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MilestoneStatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the milestone. A list of accepted values is defined in the lookup ORA_SVC_MILESTONE_STATUS_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the milestone was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the milestone.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoryId":{
            "title":"History ID",
            "type":"integer",
            "description":"The unique identifier of the milestone history.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndTime":{
            "type":"string",
            "description":"The date and time when the milestone exited the status.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Description",
            "maxLength":400,
            "type":"string",
            "description":"The comments the agent made about the milestone. For example, why the due date was overridden.",
            "nullable":true,
            "x-queryable":true
        },
        "AccumulatedTimeInStatus":{
            "title":"Accumulated Time",
            "type":"integer",
            "description":"The total time the service request milestone spent in the status.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartTime":{
            "title":"Date",
            "type":"string",
            "description":"The date and time when the milestone status was changed.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "SrMilestoneId":{
            "title":"Milestone ID",
            "type":"integer",
            "description":"The unique identifier of the service request milestone.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OverriddenDueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"Indicates the new due date the agent set for the milestone.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the millstone history was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the milestone history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

リンク

CoveredLevelLookup

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

• ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_COVERED_LEVEL

サブスクリプション対象レベルの値リスト。

Milestone_StatusCdLookup

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

• ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_SVC_MILESTONE_STATUS_CD

サービス・リクエスト・マイルストン・ステータスの値リスト。

SrMilestoneHistory

操作: /crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srMilestone/{SrMilestoneId}/child/SrMilestoneHistory

パラメータ:

• SrMilestoneId: $request.path.SrMilestoneId
• SrNumber: $request.path.SrNumber

マイルストン・コード・リソースは、マイルストン・トラッキングが開始、一時停止、完了としてマークされた時間または再起動された時間エントリのリストなど、サービス・リクエストのマイルストン・ステータスの変更の履歴を表示、作成、更新および削除するために使用されます。

Yes_NoLookup

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

• ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO

エージェントがマイルストンを完了したかどうかを示す値リスト。

トップに戻る

例:

次の例は、RESTリソースでPATCHリクエストを発行してサービス・リクエスト・マイルストンを更新する方法を示しています。

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

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

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

リクエスト本文の例

次に、リクエスト本文の例を示します。

{
	"EntitlementId": -2
}

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

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

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

レスポンス本文の例

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

{
  "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-21T09:42:50+00:00",
  "LastUpdateLogin": "4D81DDEFB30029E8E05356C0F20A4BE1",
  "LastUpdatedBy": "SALES_ADMIN",
  "MilestoneStatusCd": "ORA_SVC_IN_PROGRESS",
  "SrId": 300100114883796,
  "SrMilestoneId": 300100114883833,
  "WarnedFlag": false,
  "WarningDate": "2017-04-21T08:51:00+00:00",
  "EntitlementId": -2,
  "CoverageId": 300100091977325,
  "MilestoneConfigId": 100100052668202,
  "MilestoneLabel": "First Response Metric",
  "StartConditionLabel": "New",
  "PauseConditionLabel": "Never",
  "TimeRemaining": "26 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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
      }
    },
    {
      "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"
    }
  ]
}

「トップに戻る」