Get a milestone
get
/crmRestApi/resources/11.13.18.05/milestones/{MilestoneConfigId}
Request
Path Parameters
-
MilestoneConfigId(required): integer(int64)
The unique identifier of the milestone configuration.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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:
Examples
The following example shows how to get a milestone by submitting a GET request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/milestones/100100053060536
Example of Response Body
The following shows an example of the response body in JSON format.
{
"MilestoneConfigId": 100100053060536,
"MilestoneCode": "FirstResponseMetricCode",
"MilestoneLabel": "First Response Metric",
"MilestoneTypeMeaning": "Cannot be repeated",
"MilestoneType": "ORA_SVC_NO_REPEAT",
"ThresholdCode": "FirstResponseWarningMetricCode",
"StartCondition": "'Immediate'",
"StartConditionLabel": "Service Request is created.",
"PauseCondition": "'Never'",
"PauseConditionLabel": "Never",
"StopCondition": "'USER_SENDS_RESPONSE'",
"StopConditionLabel": "A response message is sent to the customer.",
"CreationDate": "2017-06-26T20:18:49.328+00:00",
"CreatedBy": "SEED_DATA_FROM_APPLICATION",
"LastUpdateDate": "2017-06-26T20:18:49.328+00:00",
"LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
"LastUpdateLogin": "-1",
"DeletedFlag": false,
"DisabledFlag": false,
"BUOrgId": 204,
"BusinessUnitName": "Vision Operations",
"AllowDueDateOverrideFlag": false,
"AllowAgentCompletionFlag": false,
"ObjectName": "ServiceRequest",
"ObjectNameMeaning": "Service Request",
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/milestones/100100053060536",
"name": "milestones",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/milestones/100100053060536",
"name": "milestones",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/milestones/100100053060536/lov/BusinessUnitLOV",
"name": "BusinessUnitLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/milestones/100100053060536/lov/YesNoLookup",
"name": "YesNoLookup",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/milestones/100100053060536/lov/MilestoneTypeLookup",
"name": "MilestoneTypeLookup",
"kind": "collection"
}
]
}