Skip to main content

Get Request

Get a request by its ID.

External Documentation

To learn more, visit the Absolute documentation.

Parameters​

ParameterDescription
LimitThe amount of the results to return. Valid range is 0 - 500.
Next Page TokenThe next page token returned in the previous request.
Request IDThe ID of the request.

Example Output​

{
    "data": [
        {
            "changedDateTimeUtc": "The date and time (ISO 8601) the Freeze request was last modified",
            "configuration": {
                "action": "The type of action being performed on the device\u003cbr\u003eAlways `DFZ`",
                "conditions": [
                    {
                        "scheduledFreezeDateTimeUtc": "The date and time (ISO 8601) that a Freeze request is scheduled to be performed\u003cbr\u003eIncluded when `configuration.type` is `Scheduled`",
                        "secondsUntilFreeze": 0
                    }
                ],
                "disableFileSharing": false,
                "disableRemoteLogin": false,
                "forceReboot": false,
                "freezeId": "The user-friendly identifier of the Freeze request that is displayed in event history in the Secure Endpoint Console\u003cbr\u003eThe same as `eventHistoryId`",
                "freezeMessage": "The user-defined Freeze message without the HTML tags\u003cbr\u003eThe same as `configuration.htmlClear` except it does not contain the HTML tags",
                "html": "The encoded value of `configuration.htmlClear`",
                "htmlClear": "The user-defined, HTML coded Freeze message\u003cbr\u003eThe same as `configuration.freezeMessage` except it contains the HTML tags",
                "issuedDateTimeUTC": "The date and time (ISO 8601) the Freeze request was created",
                "messageName": "The user-defined name of the Freeze message",
                "passcodeClear": "The 4 to 8 digit numerical unfreeze code that can be used to immediately unfreeze a frozen device",
                "passcodeHashed": "The hashed value of the unfreeze code",
                "passcodeLength": 0,
                "passcodeOption": "The method used to generate the unfreeze code\u003cul\u003e\u003cli\u003e`UserDefined`: a user-defined unfreeze code was generated and is the same for all devices\u003c/li\u003e\u003cli\u003e`RandomForAll`: an unfreeze code was randomly generated and is the same for all devices\u003c/li\u003e\u003cli\u003e`RandomForEach`: a unique unfreeze code was randomly generated for each device\u003c/li\u003e\u003c/ul\u003e",
                "passcodeSalt": "The salt used for hashing the unfreeze code before the unfreeze code is sent to the device",
                "preLoginEnabled": false,
                "serviceControlList": "The list of service controls that the server sends to the device",
                "type": "The type of Freeze\u003cul\u003e\u003cli\u003e`OnDemand`: Freezes the device on the next connection with the Absolute Monitoring Center, typically within 15 minutes\u003c/li\u003e\u003cli\u003e`Scheduled`: Freezes a device on its next connection with the Absolute Monitoring Center on or after a specified date and time\u003c/li\u003e\u003c/ul\u003e"
            },
            "createdDateTimeUtc": "The date and time (ISO 8601) the Freeze request was created",
            "deviceUid": "The system-defined unique identifier of the device",
            "eventHistoryId": "The user-friendly identifier of the request that is displayed in the event history in the Secure Endpoint Console",
            "freezePolicyUid": "The system-defined unique identifier of the Freeze policy\u003cbr\u003eAlways `null`",
            "id": "The system-defined unique device action identifier of the Freeze request for a single device",
            "isCurrent": false,
            "isDownloaded": false,
            "notificationEmails": [
                "An array of email addresses that receive an email notification when the status of the Freeze request changes"
            ],
            "policyConfigurationVersion": 0,
            "policyGroupUid": "The system-defined unique identifier of the policy group that the device belongs to",
            "requestTitle": "The user-defined title of the Device Action request",
            "requestUid": "The system-defined unique identifier of the Device Action request",
            "requester": "The username of the entity that created the Freeze request",
            "statuses": [
                {
                    "ackClientDateTimeUtc": "The date and time (ISO 8601) of the acknowledgement time stamp when the request was downloaded to the device",
                    "actionUid": "The system-defined unique identifier of the Freeze action",
                    "eventType": "The Freeze event type",
                    "instruction": "The action instructions sent from the device's DFZ agent component\u003cul\u003e\u003cli\u003e`Freeze`\u003c/li\u003e\u003cli\u003e`Launch`\u003c/li\u003e\u003cli\u003e`Remove`\u003c/li\u003e\u003cli\u003e`RemoveOnNextUnfreeze`\u003c/li\u003e\u003cli\u003e`Replace`\u003c/li\u003e\u003cli\u003e`Unfreeze`\u003c/li\u003e\u003cli\u003e`UnfreezeByRemove`\u003c/li\u003e\u003cli\u003e`null`\u003c/li\u003e\u003c/ul\u003e",
                    "message": "The message for the status change that occurred\u003cbr\u003eExamples:\u003cul\u003e\u003cli\u003eIf `statuses.status` is `Removed`, `statuses.message` is `Device unlocked. Unfreeze performed.`\u003c/li\u003e\u003cli\u003eIf `statuses.status` is `Frozen`, `statuses.message` is `Device locked. Freeze performed.`\u003c/li\u003e\u003c/ul\u003e",
                    "messageKey": "The reference key for the error message or info message, such as:\u003cul\u003e\u003cli\u003eerror message\u003cul\u003e\u003cli\u003e`dds.deviceFreeze.error.platformOSTypeMissing`\u003c/li\u003e\u003cli\u003e`dds.actionFramework.errors.Configure`\u003c/li\u003e\u003c/ul\u003e\u003c/li\u003e\u003cli\u003einfo message\u003cul\u003e\u003cli\u003e`ddsui.ccDeviceFreeze.eventMessage.Freeze`\u003c/li\u003e\u003c/ul\u003e\u003c/li\u003e\u003c/ul\u003eThis may be `null` depending on the value of `statuses.status`",
                    "messageParams": [
                        "A list of strings describing the error message when `statuses.status` is `LaunchFailed`, such as:\u003cbr\u003e`\"Provider [DFZ] returned [0] with the following error message [action file parsing error!\\n]\"`\u003cbr\u003eIf `statuses.status` is not `launchFailed`, this is `null`"
                    ],
                    "scheduledFreezeDateTimeUtc": "The date and time (ISO 8601) the Scheduled Freeze request was scheduled to be performed",
                    "status": "The status of the Freeze request on the device",
                    "triggerActionUid": "The system-defined unique identifier of a new Freeze request that replaces a Freeze request of the same type\u003cbr\u003eIn all other cases, `statuses.triggerActionUid` is `null`",
                    "updatedBy": "The user name of the entity that last updated the Freeze request",
                    "updatedDateTimeUtc": "The date and time (ISO 8601) the Freeze request was last updated"
                }
            ]
        }
    ],
    "metadata": {
        "pagination": {
            "nextPage": "The pagination token that can be used to get the next page of results"
        }
    }
}

Workflow Library Example​

Get Request with Absolute and Send Results Via Email

Workflow LibraryPreview this Workflow on desktop