Update a milestone
patch
/crmRestApi/resources/11.13.18.05/milestones/{MilestoneConfigId}
Request
Path Parameters
-
MilestoneConfigId(required): integer(int64)
The unique identifier of the milestone configuration.
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
-
AllowAgentCompletionFlag: boolean
Title:
Allow Agent Completion
Maximum Length:1
Default Value:false
Allow Agent to mark milestone as complete -
AllowDueDateOverrideFlag: boolean
Title:
Allow Due Date Override
Maximum Length:1
Default Value:false
Allow Agent to override milestone due date -
BUOrgId: integer
(int64)
The unique ID of the business unit name associated to the Milestone Config.
-
DeletedFlag: boolean
Maximum Length:
1
Default Value:false
Deleted Flag -
DisabledFlag: boolean
Title:
Disabled
Maximum Length:1
Default Value:false
Disabled Flag -
MilestoneLabel: string
Title:
Milestone Label
Maximum Length:255
The user-friendly label of the milestone. -
MilestoneType: string
Title:
Milestone Type
Maximum Length:255
Default Value:ORA_SVC_NO_REPEAT
The type of the milestone. -
ObjectName: string
Maximum Length:
255
The name of the object associated to the Milestone Configuration -
PauseCondition: string
Title:
Pauses When
Maximum Length:1000
Pause Condition -
PauseConditionLabel: string
Title:
Pauses When
Maximum Length:1000
The user-friendly label of the milestone's pause condition. -
StartCondition: string
Title:
Starts When
Maximum Length:1000
Start Condition -
StartConditionLabel: string
Title:
Starts When
Maximum Length:1000
The user-friendly label of the milestone's start condition. -
StopCondition: string
Title:
Complete When
Maximum Length:1000
Stop Condition -
StopConditionLabel: string
Title:
Completes When
Maximum Length:1000
The user-friendly label of the milestone's stop condition. -
ThresholdCode: string
Title:
Threshold Code
Maximum Length:255
The unique code associated with the threshold. -
TzPreferenceCd: string
Title:
Time Zone Override Source
Maximum Length:30
Indicates the object that will be used to override the time zone from the coverage.
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 : milestones-item-response
Type:
Show Source
object
-
AllowAgentCompletionFlag: boolean
Title:
Allow Agent Completion
Maximum Length:1
Default Value:false
Allow Agent to mark milestone as complete -
AllowDueDateOverrideFlag: boolean
Title:
Allow Due Date Override
Maximum Length:1
Default Value:false
Allow Agent to override milestone due date -
BUOrgId: integer
(int64)
The unique ID of the business unit name associated to the Milestone Config.
-
BusinessUnitName: string
Title:
Business Unit Name
Read Only:true
Maximum Length:240
The name of the business unit associated to the Milestone Configuration -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Created By -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Creation Date -
DeletedFlag: boolean
Maximum Length:
1
Default Value:false
Deleted Flag -
DisabledFlag: boolean
Title:
Disabled
Maximum Length:1
Default Value:false
Disabled Flag -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Last Update Date -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Last Updated By -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
Last Update Login -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MilestoneCode: string
Title:
Milestone Code
Maximum Length:255
The unique code associated with the milestone. -
MilestoneConfigId: integer
(int64)
Title:
Milestone Configuration ID
Read Only:true
The unique identifier of the milestone configuration. -
MilestoneLabel: string
Title:
Milestone Label
Maximum Length:255
The user-friendly label of the milestone. -
MilestoneType: string
Title:
Milestone Type
Maximum Length:255
Default Value:ORA_SVC_NO_REPEAT
The type of the milestone. -
MilestoneTypeMeaning: string
Read Only:
true
Indicates the display value corresponding to the milestone type lookup code. -
ObjectName: string
Maximum Length:
255
The name of the object associated to the Milestone Configuration -
ObjectNameMeaning: string
Read Only:
true
Indicates the display value corresponding to the object name lookup code. -
PauseCondition: string
Title:
Pauses When
Maximum Length:1000
Pause Condition -
PauseConditionLabel: string
Title:
Pauses When
Maximum Length:1000
The user-friendly label of the milestone's pause condition. -
StartCondition: string
Title:
Starts When
Maximum Length:1000
Start Condition -
StartConditionLabel: string
Title:
Starts When
Maximum Length:1000
The user-friendly label of the milestone's start condition. -
StopCondition: string
Title:
Complete When
Maximum Length:1000
Stop Condition -
StopConditionLabel: string
Title:
Completes When
Maximum Length:1000
The user-friendly label of the milestone's stop condition. -
ThresholdCode: string
Title:
Threshold Code
Maximum Length:255
The unique code associated with the threshold. -
TzPreferenceCd: string
Title:
Time Zone Override Source
Maximum Length:30
Indicates the object that will be used to override the time zone from the coverage. -
TzPreferenceMeaning: string
Read Only:
true
Maximum Length:255
Indicates the display value corresponding to the time zone object lookup code.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
Links
- YesNoLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
The following properties are defined on the LOV link relation:- Source Attribute: AllowAgentCompletionFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: