Update a service request milestone
patch
/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/srMilestone/{SrMilestoneId}
Request
Path Parameters
-
SrMilestoneId(required): integer(int64)
The unique identifier of the milestone.
-
SrNumber(required): string
The unique number that is used to identify a service request. You can configure the service request number to a format that is best suitable to your organizational requirements. For example, service request may have the formats service request0000012345, service request_000_12345, 12345_00_service request, and so on depending on your requirements.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:false
Indicates that the milestone is active. -
AgentCompletedFlag: boolean
Title:
Agent Completed
Maximum Length:1
Default Value:false
Indicates whether agent marked the milestone as complete. -
Comments: string
Title:
Comments
Maximum Length:400
The comments the agent made about the milestone. For example, why the due date was overridden. -
CompletionDate: string
(date-time)
Title:
Completion Date
The date when the milestone was completed. -
ComplianceFlag: boolean
Title:
Compliance
Maximum Length:1
Default Value:true
Indicates whether the milestone is compliant or not. The default value is true. -
CoverageSourceCd: string
Title:
Coverage Source
Maximum Length:120
Coverage Source -
DelayTime: integer
(int64)
Title:
Delay Time
The amount of time the milestones has been delayed from the due date. -
DueDate: string
(date-time)
The date when the milestone is due.
-
EntitlementId: integer
The unique identifier of the entitlement for the milestone.
-
MilestoneStatusCd: string
Title:
Status
Maximum Length:30
The code indicating the status of the milestone. A list of accepted values is defined in the lookup ORA_SVC_MILESTONE_STATUS_CD. -
SrAssigneePartyId: integer
Title:
Assigned to Party ID
The unique identifier of the resource assigned to the service request. -
SrMilestoneHistory: array
Milestone Codes
Title:
Milestone Codes
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. -
SubscriptionNumber: string
Title:
Subscription Number
Maximum Length:120
Subscription Number -
TimeLeftOnceUnpaused: integer
Title:
Paused Minutes Remaining
The time left to complete the milestone after the service request is restored from a paused state. -
WarnedFlag: boolean
Title:
Warned
Maximum Length:1
Default Value:false
Indicates whether the milestone has passed the warning threshold. -
WarningDate: string
(date-time)
Title:
Warning Date
The date and time when the milestone passed the warning threshold.
Nested Schema : Milestone Codes
Type:
array
Title:
Milestone Codes
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.
Show Source
Nested Schema : serviceRequests-srMilestone-SrMilestoneHistory-item-patch-request
Type:
Show Source
object
-
AccumulatedTimeInStatus: integer
(int64)
Title:
Accumulated Time
The total time the service request milestone spent in the status. -
Comments: string
Title:
Description
Maximum Length:400
The comments the agent made about the milestone. For example, why the due date was overridden. -
EndTime: string
(date-time)
The date and time when the milestone exited the status.
-
MilestoneStatusCd: string
Title:
Status
Maximum Length:30
The code indicating the status of the milestone. A list of accepted values is defined in the lookup ORA_SVC_MILESTONE_STATUS_CD. -
OverriddenDueDate: string
(date-time)
Title:
Due Date
Indicates the new due date the agent set for the milestone. -
SrMilestoneId: integer
(int64)
Title:
Milestone ID
The unique identifier of the service request milestone. -
StartTime: string
(date-time)
Title:
Date
The date and time when the milestone status was changed.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : serviceRequests-srMilestone-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:false
Indicates that the milestone is active. -
AgentCompletedFlag: boolean
Title:
Agent Completed
Maximum Length:1
Default Value:false
Indicates whether agent marked the milestone as complete. -
AllowAgentCompletionFlag: boolean
Title:
Allow Agent Completion
Read Only:true
Maximum Length:1
Default Value:false
Indicates whether an agent can mark the milestone as complete. -
AllowDueDateOverrideFlag: boolean
Title:
Allow Due Date Override
Read Only:true
Maximum Length:1
Default Value:false
Indicates whether an agent can override the milestone due date. -
Comments: string
Title:
Comments
Maximum Length:400
The comments the agent made about the milestone. For example, why the due date was overridden. -
CompletionDate: string
(date-time)
Title:
Completion Date
The date when the milestone was completed. -
ComplianceFlag: boolean
Title:
Compliance
Maximum Length:1
Default Value:true
Indicates whether the milestone is compliant or not. The default value is true. -
CoverageId: integer
(int64)
Title:
Coverage ID
The unique identifier of the service request coverage. -
CoverageSourceCd: string
Title:
Coverage Source
Maximum Length:120
Coverage Source -
CoverageSourceCdMeaning: string
Title:
Coverage Source
Read Only:true
The display value corresponding to the coverage source lookup code. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the milestone. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the milestone was created. -
DelayTime: integer
(int64)
Title:
Delay Time
The amount of time the milestones has been delayed from the due date. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Indicates if the milestone has been deleted. -
DueDate: string
(date-time)
The date when the milestone is due.
-
EntitlementId: integer
The unique identifier of the entitlement for the milestone.
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the milestone was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the milestone. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the milestone. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MilestoneConfigId: integer
(int64)
Title:
Milestone Configuration ID
The unique identifier of the milestone configuration. -
MilestoneLabel: string
Title:
Name
Read Only:true
Maximum Length:255
The display name of the milestone. -
MilestoneStatusCd: string
Title:
Status
Maximum Length:30
The code indicating the status of the milestone. A list of accepted values is defined in the lookup ORA_SVC_MILESTONE_STATUS_CD. -
MilestoneStatusCdMeaning: string
Title:
Milestone Status
Read Only:true
Maximum Length:255
The display value corresponding to the status lookup code for the milestone. -
PauseConditionLabel: string
Title:
Pauses When
Read Only:true
Maximum Length:1000
The condition of the milestone when it pauses. -
SrAssigneePartyId: integer
Title:
Assigned to Party ID
The unique identifier of the resource assigned to the service request. -
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the service request. -
SrMilestoneHistory: array
Milestone Codes
Title:
Milestone Codes
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. -
SrMilestoneId: integer
(int64)
Title:
Milestone ID
Read Only:true
The unique identifier of the milestone. -
StartConditionLabel: string
Title:
Starts When
Read Only:true
Maximum Length:1000
The condition of the milestone when it starts. -
SubscriptionCoveragePuid: string
Title:
Subscription Coverage PUID
Maximum Length:120
Subscription Coverage PUID -
SubscriptionNumber: string
Title:
Subscription Number
Maximum Length:120
Subscription Number -
TimeLeftOnceUnpaused: integer
Title:
Paused Minutes Remaining
The time left to complete the milestone after the service request is restored from a paused state. -
TimeRemaining: string
Title:
Time Remaining
Read Only:true
The time remaining in the milestone. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates if the milestone has been updated. -
WarnedFlag: boolean
Title:
Warned
Maximum Length:1
Default Value:false
Indicates whether the milestone has passed the warning threshold. -
WarningDate: string
(date-time)
Title:
Warning Date
The date and time when the milestone passed the warning threshold.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Milestone Codes
Type:
array
Title:
Milestone Codes
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.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : serviceRequests-srMilestone-SrMilestoneHistory-item-response
Type:
Show Source
object
-
AccumulatedTimeInStatus: integer
(int64)
Title:
Accumulated Time
The total time the service request milestone spent in the status. -
Comments: string
Title:
Description
Maximum Length:400
The comments the agent made about the milestone. For example, why the due date was overridden. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the milestone. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the milestone was created. -
EndTime: string
(date-time)
The date and time when the milestone exited the status.
-
HistoryId: integer
(int64)
Title:
History ID
Read Only:true
The unique identifier of the milestone history. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the millstone history was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the milestone history. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the milestone history. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MilestoneStatusCd: string
Title:
Status
Maximum Length:30
The code indicating the status of the milestone. A list of accepted values is defined in the lookup ORA_SVC_MILESTONE_STATUS_CD. -
OverriddenDueDate: string
(date-time)
Title:
Due Date
Indicates the new due date the agent set for the milestone. -
SrMilestoneId: integer
(int64)
Title:
Milestone ID
The unique identifier of the service request milestone. -
StartTime: string
(date-time)
Title:
Date
The date and time when the milestone status was changed.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- CoveredLevelLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_COVERED_LEVEL
The list of values for subscription covered levels. - finder:
- Milestone_StatusCdLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_SVC_MILESTONE_STATUS_CD
The list of values for the service request milestone status. - finder:
- SrMilestoneHistory
-
Parameters:
- SrMilestoneId:
$request.path.SrMilestoneId
- SrNumber:
$request.path.SrNumber
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. - SrMilestoneId:
- Yes_NoLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
The list of values indicating if the agent completed the milestone. - finder:
Examples
The following example shows how to update a service request milestone by submitting a PATCH request on the REST resource.
Example of Request Header
The following shows an example of the request header.
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
Example of Request Body
The following shows an example of the request body.
{ "EntitlementId": -2 }
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Server: Oracle-HTTP-Server-11g Content-Type: application/vnd.oracle.adf.resourceitem+json Content-Language: en
Example of Response Body
The following example shows the contents of the response body.
{ "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" } ] }