Update a service request milestone
patch
/crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srMilestone/{SrMilestoneId}
Request
Path Parameters
-
SrId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
SrMilestoneId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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 whether the service request 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 customer or agent comments. -
CompletionDate: string
(date-time)
Title:
Completion Date
The date when the milestone is to be completed. -
ComplianceFlag: boolean
Title:
Compliance
Maximum Length:1
Default Value:true
The compliance status of the milestone. -
CoverageSourceCd: string
Title:
Coverage Source
Maximum Length:120
Coverage Source -
DelayTime: integer
(int64)
Title:
Delay Time
The time between the due date and the completion date. -
DueDate: string
(date-time)
The due date of the milestone.
-
EntitlementId: integer
The unique identifier of the entitlement record.
-
MilestoneStatusCd: string
Title:
Status
Maximum Length:30
The status of the milestone. -
SrAssigneePartyId: integer
Title:
Assigned to Party ID
The unique party object identifier of the service request assignee. -
SrMilestoneHistory: array
Milestones History
Title:
Milestones History
The list of changes in the service request milestone status. -
SubscriptionNumber: string
Title:
Subscription Number
Maximum Length:120
Subscription Number -
TimeLeftOnceUnpaused: integer
Title:
Paused Minutes Remaining
The time left, in minutes, to complete the milestone after it's restored from the paused state. -
WarnedFlag: boolean
Title:
Warned
Maximum Length:1
Default Value:false
Indicates whether milestone passed the warning threshold. -
WarningDate: string
(date-time)
Title:
Warning Date
The date and time when the milestone passed the warning threshold.
Nested Schema : Milestones History
Type:
array
Title:
Milestones History
The list of changes in the service request milestone status.
Show Source
Nested Schema : internalServiceRequests-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 of the agent. -
EndTime: string
(date-time)
The date and time when the milestone exited the status.
-
MilestoneStatusCd: string
Title:
Status
Maximum Length:30
The status of the milestone. -
OverriddenDueDate: string
(date-time)
Title:
Due Date
The milestone overridden due date. -
SrMilestoneId: integer
(int64)
Title:
Milestone ID
The unique identifier of the service request milestone record. -
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 : internalServiceRequests-srMilestone-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:false
Indicates whether the service request 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 customer or agent comments. -
CompletionDate: string
(date-time)
Title:
Completion Date
The date when the milestone is to be completed. -
ComplianceFlag: boolean
Title:
Compliance
Maximum Length:1
Default Value:true
The compliance status of the milestone. -
CoverageId: integer
(int64)
Title:
Coverage ID
The unique identifier for the coverage record. -
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 record was created. -
DelayTime: integer
(int64)
Title:
Delay Time
The time between the due date and the completion date. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Indicates whether the user has access to delete the record. -
DueDate: string
(date-time)
The due date of the milestone.
-
EntitlementId: integer
The unique identifier of the entitlement record.
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record 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 record. -
MilestoneLabel: string
Title:
Name
Read Only:true
Maximum Length:255
The name of the milestone. -
MilestoneStatusCd: string
Title:
Status
Maximum Length:30
The status of the milestone. -
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 time when the milestone pauses. -
SrAssigneePartyId: integer
Title:
Assigned to Party ID
The unique party object identifier of the service request assignee. -
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the service request record. -
SrMilestoneHistory: array
Milestones History
Title:
Milestones History
The list of changes in the service request milestone status. -
SrMilestoneId: integer
(int64)
Title:
Milestone ID
Read Only:true
The unique identifier of the service request milestone record. -
StartConditionLabel: string
Title:
Starts When
Read Only:true
Maximum Length:1000
The time when the milestone 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, in minutes, to complete the milestone after it's restored from the 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 whether the user has access to update the record. -
WarnedFlag: boolean
Title:
Warned
Maximum Length:1
Default Value:false
Indicates whether milestone 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 : Milestones History
Type:
array
Title:
Milestones History
The list of changes in the service request milestone status.
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 : internalServiceRequests-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 of the agent. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record 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 record. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record 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 status of the milestone. -
OverriddenDueDate: string
(date-time)
Title:
Due Date
The milestone overridden due date. -
SrMilestoneId: integer
(int64)
Title:
Milestone ID
The unique identifier of the service request milestone record. -
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 following properties are defined on the LOV link relation:- Source Attribute: CoverageSourceCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- Milestone_StatusCdLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_SVC_MILESTONE_STATUS_CD
The following properties are defined on the LOV link relation:- Source Attribute: MilestoneStatusCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SrMilestoneHistory
-
Parameters:
- SrId:
$request.path.SrId
- SrMilestoneId:
$request.path.SrMilestoneId
The list of changes in the service request milestone status. - SrId:
- Yes_NoLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
The following properties are defined on the LOV link relation:- Source Attribute: AgentCompletedFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: