Jump to

• Request
• Response
• Examples

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.
• 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: string
  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: string
  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 Top

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.

Body ()

Root Schema : internalServiceRequests-srMilestone

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/internalServiceRequests-srMilestone-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object internalServiceRequests-srMilestone-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/internalServiceRequests-srMilestone-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : internalServiceRequests-srMilestone-item-response

Type: object

Show Source

• 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)
  Title: Due Date

  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.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the service request milestone is active.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "AgentCompletedFlag":{
            "title":"Agent Completed",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether agent marked the milestone as complete.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "AllowAgentCompletionFlag":{
            "title":"Allow Agent Completion",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an agent can mark the milestone as complete.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "AllowDueDateOverrideFlag":{
            "title":"Allow Due Date Override",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an agent can override the milestone due date.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":400,
            "type":"string",
            "description":"The customer or agent comments.",
            "nullable":true,
            "x-queryable":true
        },
        "CompletionDate":{
            "title":"Completion Date",
            "type":"string",
            "description":"The date when the milestone is to be completed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ComplianceFlag":{
            "title":"Compliance",
            "maxLength":1,
            "type":"boolean",
            "description":"The compliance status of the milestone.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "CoverageId":{
            "title":"Coverage ID",
            "type":"integer",
            "description":"The unique identifier for the coverage record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CoverageSourceCd":{
            "title":"Coverage Source",
            "maxLength":120,
            "type":"string",
            "description":"Coverage Source",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CoverageSourceCdMeaning":{
            "title":"Coverage Source",
            "type":"string",
            "description":"The display value corresponding to the coverage source lookup code.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CoverageSourceCd"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the milestone.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DelayTime":{
            "title":"Delay Time",
            "type":"integer",
            "description":"The time between the due date and the completion date.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The due date of the milestone.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "EntitlementId":{
            "type":"integer",
            "description":"The unique identifier of the entitlement record.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the milestone.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the milestone.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MilestoneConfigId":{
            "title":"Milestone Configuration ID",
            "type":"integer",
            "description":"The unique identifier of the milestone configuration record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MilestoneLabel":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the milestone.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MilestoneStatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the milestone.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MilestoneStatusCdMeaning":{
            "title":"Milestone Status",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the status lookup code for the milestone.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "MilestoneStatusCd"
                ]
            },
            "x-queryable":true
        },
        "PauseConditionLabel":{
            "title":"Pauses When",
            "maxLength":1000,
            "type":"string",
            "description":"The time when the milestone pauses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SrAssigneePartyId":{
            "title":"Assigned to Party ID",
            "type":"integer",
            "description":"The unique party object identifier of the service request assignee.",
            "nullable":true,
            "x-queryable":true
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SrMilestoneHistory":{
            "title":"Milestones History",
            "type":"array",
            "description":"The list of changes in the service request milestone status.",
            "items":{
                "$ref":"#/components/schemas/internalServiceRequests-srMilestone-SrMilestoneHistory-item-response"
            }
        },
        "SrMilestoneId":{
            "title":"Milestone ID",
            "type":"integer",
            "description":"The unique identifier of the service request milestone record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartConditionLabel":{
            "title":"Starts When",
            "maxLength":1000,
            "type":"string",
            "description":"The time when the milestone starts.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionCoveragePuid":{
            "title":"Subscription Coverage PUID",
            "maxLength":120,
            "type":"string",
            "description":"Subscription Coverage PUID",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":120,
            "type":"string",
            "description":"Subscription Number",
            "nullable":true,
            "x-queryable":true
        },
        "TimeLeftOnceUnpaused":{
            "title":"Paused Minutes Remaining",
            "type":"integer",
            "description":"The time left, in minutes, to complete the milestone after it's restored from the paused state.",
            "nullable":true,
            "x-queryable":true
        },
        "TimeRemaining":{
            "title":"Time Remaining",
            "type":"string",
            "description":"The time remaining in the milestone.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates whether the user has access to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WarnedFlag":{
            "title":"Warned",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether milestone passed the warning threshold.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "WarningDate":{
            "title":"Warning Date",
            "type":"string",
            "description":"The date and time when the milestone passed the warning threshold.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Milestones History

Type: array

Title: Milestones History

The list of changes in the service request milestone status.

Show Source

• Array of: object internalServiceRequests-srMilestone-SrMilestoneHistory-item-response

{
    "title":"Milestones History",
    "type":"array",
    "description":"The list of changes in the service request milestone status.",
    "items":{
        "$ref":"#/components/schemas/internalServiceRequests-srMilestone-SrMilestoneHistory-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : internalServiceRequests-srMilestone-SrMilestoneHistory-item-response

Type: object

Show Source

• AccumulatedTimeInStatus: integer (int64)
  Title: Accumulated Time

  The total time the service request milestone spent in the status.
• Comments: string
  Title: Comments

  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.

{
    "type":"object",
    "properties":{
        "AccumulatedTimeInStatus":{
            "title":"Accumulated Time",
            "type":"integer",
            "description":"The total time the service request milestone spent in the status.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":400,
            "type":"string",
            "description":"The comments of the agent.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndTime":{
            "type":"string",
            "description":"The date and time when the milestone exited the status.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "HistoryId":{
            "title":"History ID",
            "type":"integer",
            "description":"The unique identifier of the milestone history record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the milestone history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the milestone history.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MilestoneStatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the milestone.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OverriddenDueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The milestone overridden due date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SrMilestoneId":{
            "title":"Milestone ID",
            "type":"integer",
            "description":"The unique identifier of the service request milestone record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartTime":{
            "title":"Date",
            "type":"string",
            "description":"The date and time when the milestone status was changed.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top

Examples

The following example shows how to get all service request milestones of an internal service request 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/internalServiceRequests/ISR0000006004/child/srMilestone'

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "ActiveFlag": true,
            "CompletionDate": null,
            "ComplianceFlag": true,
            "CreatedBy": "automisrhdadm1",
            "CreationDate": "2024-12-09T22:47:17.178+00:00",
            "DueDate": "2024-12-09T23:07:00+00:00",
            "LastUpdateDate": "2024-12-09T22:47:17.582+00:00",
            "LastUpdateLogin": "28A5638738CB8B1DE0635F10060A6054",
            "LastUpdatedBy": "automisrhdadm1",
            "MilestoneStatusCdMeaning": "In Progress",
            "MilestoneStatusCd": "ORA_SVC_IN_PROGRESS",
            "SrId": 300100627047030,
            "SrMilestoneId": 300100627056933,
            "WarnedFlag": false,
            "WarningDate": "2024-12-09T22:57:00+00:00",
            "CoverageId": 300100625853009,
            "MilestoneConfigId": 300100545297675,
            "MilestoneLabel": "Resolution Metric",
            "StartConditionLabel": "Service Request is created.",
            "PauseConditionLabel": "Service Request status type is set to Waiting on Customer.",
            "TimeRemaining": "1 day late",
            "DelayTime": null,
            "SrAssigneePartyId": null,
            "UpdateFlag": true,
            "DeleteFlag": true,
            "TimeLeftOnceUnpaused": null,
            "EntitlementId": null,
            "Comments": null,
            "AgentCompletedFlag": false,
            "AllowDueDateOverrideFlag": false,
            "AllowAgentCompletionFlag": false,
            "SubscriptionNumber": null,
            "SubscriptionCoveragePuid": "CDRM_6036",
            "CoverageSourceCd": null,
            "CoverageSourceCdMeaning": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/internalServiceRequests/ISR0000006004/child/srMilestone/300100627056933",
                    "name": "srMilestone",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/internalServiceRequests/ISR0000006004/child/srMilestone/300100627056933",
                    "name": "srMilestone",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/internalServiceRequests/ISR0000006004",
                    "name": "internalServiceRequests",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/internalServiceRequests/ISR0000006004/child/srMilestone/300100627056933/lov/CoveredLevelLookup",
                    "name": "CoveredLevelLookup",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/internalServiceRequests/ISR0000006004/child/srMilestone/300100627056933/lov/Milestone_StatusCdLookup",
                    "name": "Milestone_StatusCdLookup",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/internalServiceRequests/ISR0000006004/child/srMilestone/300100627056933/lov/Yes_NoLookup",
                    "name": "Yes_NoLookup",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/internalServiceRequests/ISR0000006004/child/srMilestone/300100627056933/child/SrMilestoneHistory",
                    "name": "SrMilestoneHistory",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActiveFlag": true,
            "CompletionDate": null,
            "ComplianceFlag": true,
            "CreatedBy": "automisrhdadm1",
            "CreationDate": "2024-12-09T22:47:17.564+00:00",
            "DueDate": "2024-12-09T22:57:00+00:00",
            "LastUpdateDate": "2024-12-09T22:47:17.961+00:00",
            "LastUpdateLogin": "28A5638738CB8B1DE0635F10060A6054",
            "LastUpdatedBy": "automisrhdadm1",
            "MilestoneStatusCdMeaning": "In Progress",
            "MilestoneStatusCd": "ORA_SVC_IN_PROGRESS",
            "SrId": 300100627047030,
            "SrMilestoneId": 300100627056935,
            "WarnedFlag": false,
            "WarningDate": "2024-12-09T22:52:00+00:00",
            "CoverageId": 300100625853009,
            "MilestoneConfigId": 300100545297676,
            "MilestoneLabel": "First Response Metric",
            "StartConditionLabel": "Service Request is created.",
            "PauseConditionLabel": "Never",
            "TimeRemaining": "1 day late",
            "DelayTime": null,
            "SrAssigneePartyId": null,
            "UpdateFlag": true,
            "DeleteFlag": true,
            "TimeLeftOnceUnpaused": null,
            "EntitlementId": null,
            "Comments": null,
            "AgentCompletedFlag": false,
            "AllowDueDateOverrideFlag": false,
            "AllowAgentCompletionFlag": false,
            "SubscriptionNumber": null,
            "SubscriptionCoveragePuid": "CDRM_6036",
            "CoverageSourceCd": null,
            "CoverageSourceCdMeaning": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/internalServiceRequests/ISR0000006004/child/srMilestone/300100627056935",
                    "name": "srMilestone",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/internalServiceRequests/ISR0000006004/child/srMilestone/300100627056935",
                    "name": "srMilestone",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/internalServiceRequests/ISR0000006004",
                    "name": "internalServiceRequests",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/internalServiceRequests/ISR0000006004/child/srMilestone/300100627056935/lov/CoveredLevelLookup",
                    "name": "CoveredLevelLookup",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/internalServiceRequests/ISR0000006004/child/srMilestone/300100627056935/lov/Milestone_StatusCdLookup",
                    "name": "Milestone_StatusCdLookup",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/internalServiceRequests/ISR0000006004/child/srMilestone/300100627056935/lov/Yes_NoLookup",
                    "name": "Yes_NoLookup",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/internalServiceRequests/ISR0000006004/child/srMilestone/300100627056935/child/SrMilestoneHistory",
                    "name": "SrMilestoneHistory",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 2,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/internalServiceRequests/ISR0000006004/child/srMilestone",
            "name": "srMilestone",
            "kind": "collection"
        }
    ]
}

Back to Top