Get all service request milestones
get
/crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srMilestone
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=
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey :Finds a service request milestone with the specified primary key.
Finder Variables:- SrMilestoneId :The unique identifier of a service request milestone.
- PrimaryKey :Finds a service request milestone with the specified primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ActiveFlag; boolean; Indicates whether the service request milestone is active.
- AgentCompletedFlag; boolean; Indicates whether agent marked the milestone as complete.
- AllowAgentCompletionFlag; boolean; Indicates whether an agent can mark the milestone as complete.
- AllowDueDateOverrideFlag; boolean; Indicates whether an agent can override the milestone due date.
- Comments; string; The customer or agent comments.
- CompletionDate; string; The date when the milestone is to be completed.
- ComplianceFlag; boolean; The compliance status of the milestone.
- CoverageId; integer; The unique identifier for the coverage record.
- CoverageSourceCd; string; Coverage Source
- CoverageSourceCdMeaning; string; The display value corresponding to the coverage source lookup code.
- CreatedBy; string; The user who created the milestone.
- CreationDate; string; The date and time when the record was created.
- DelayTime; integer; The time between the due date and the completion date.
- DueDate; string; The due date of the milestone.
- LastUpdateDate; string; The date and time when the record was last updated.
- LastUpdateLogin; string; The login of the user who last updated the milestone.
- LastUpdatedBy; string; The user who last updated the milestone.
- MilestoneConfigId; integer; The unique identifier of the milestone configuration record.
- MilestoneLabel; string; The name of the milestone.
- MilestoneStatusCd; string; The status of the milestone.
- MilestoneStatusCdMeaning; string; The display value corresponding to the status lookup code for the milestone.
- PauseConditionLabel; string; The time when the milestone pauses.
- SrAssigneePartyId; integer; The unique party object identifier of the service request assignee.
- SrId; integer; The unique identifier of the service request record.
- SrMilestoneId; integer; The unique identifier of the service request milestone record.
- StartConditionLabel; string; The time when the milestone starts.
- SubscriptionCoveragePuid; string; Subscription Coverage PUID
- SubscriptionNumber; string; Subscription Number
- TimeLeftOnceUnpaused; integer; The time left, in minutes, to complete the milestone after it's restored from the paused state.
- TimeRemaining; string; The time remaining in the milestone.
- WarnedFlag; boolean; Indicates whether milestone passed the warning threshold.
- WarningDate; string; The date and time when the milestone passed the warning threshold.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : internalServiceRequests-srMilestone
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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