Jump to

• Request
• Response

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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

  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.

{
    "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"
            }
        },
        "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"
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":400,
            "type":"string",
            "description":"The customer or agent comments.",
            "nullable":true
        },
        "CompletionDate":{
            "title":"Completion Date",
            "type":"string",
            "description":"The date when the milestone is to be completed.",
            "format":"date-time",
            "nullable":true
        },
        "ComplianceFlag":{
            "title":"Compliance",
            "maxLength":1,
            "type":"boolean",
            "description":"The compliance status of the milestone.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "CoverageSourceCd":{
            "title":"Coverage Source",
            "maxLength":120,
            "type":"string",
            "description":"Coverage Source",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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
            }
        },
        "DueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The due date of the milestone.",
            "format":"date-time",
            "nullable":true
        },
        "EntitlementId":{
            "type":"integer",
            "description":"The unique identifier of the entitlement record.",
            "nullable":true,
            "x-queryable":false
        },
        "MilestoneStatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the milestone.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SrAssigneePartyId":{
            "title":"Assigned to Party ID",
            "type":"integer",
            "description":"The unique party object identifier of the service request assignee.",
            "nullable":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-patch-request"
            }
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":120,
            "type":"string",
            "description":"Subscription Number",
            "nullable":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
        },
        "WarnedFlag":{
            "title":"Warned",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether milestone passed the warning threshold.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "WarningDate":{
            "title":"Warning Date",
            "type":"string",
            "description":"The date and time when the milestone passed the warning threshold.",
            "format":"date-time",
            "nullable":true
        }
    }
}

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-patch-request

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

Nested Schema : internalServiceRequests-srMilestone-SrMilestoneHistory-item-patch-request

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

{
    "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
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":400,
            "type":"string",
            "description":"The comments of the agent.",
            "nullable":true
        },
        "EndTime":{
            "type":"string",
            "description":"The date and time when the milestone exited the status.",
            "format":"date-time",
            "nullable":true
        },
        "MilestoneStatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the milestone.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OverriddenDueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The milestone overridden due date.",
            "format":"date-time",
            "nullable":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
            }
        },
        "StartTime":{
            "title":"Date",
            "type":"string",
            "description":"The date and time when the milestone status was changed.",
            "format":"date-time",
            "nullable":false
        }
    }
}

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-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"
    }
}

Links

CoveredLevelLookup

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

Milestone_StatusCdLookup

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

SrMilestoneHistory

Operation: /crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/srMilestone/{SrMilestoneId}/child/SrMilestoneHistory

Parameters:

• SrId: $request.path.SrId
• SrMilestoneId: $request.path.SrMilestoneId

The list of changes in the service request milestone status.

Yes_NoLookup

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

Back to Top