Retrieve Attestation Assignment by ID

get https://{hostname}/api/v1/timekeeping/attestation_assignments/{id}

This operation returns an Attestation assignment by ID.

Responses

Response body

object

manualTimeEntryWorkflow

object

The Attestation Workflow model.

deleted

boolean

A Boolean indicator of whether or not this Attestation entity has been deleted.

versionCount

int64

The version count of an Abstract Attestation entity.

deploymentId

int64

The ID of an Abstract Attestation entity.

name

string

The name of an Attestation entity.

name

string

The name of an Attestation entity.

attestationWorkflow

object

The Attestation Workflow model.

deleted

boolean

A Boolean indicator of whether or not this Attestation entity has been deleted.

versionCount

int64

The version count of an Abstract Attestation entity.

deploymentId

int64

The ID of an Abstract Attestation entity.

name

string

The name of an Attestation entity.

deleted

boolean

A Boolean indicator of whether or not this Attestation entity has been deleted.

attestationCondition

object

The Attestation condition model.

comment

object

ObjectRef contains an id and qualifier and either field should be able to uniquely identify an Object

rangeValueEnd

int64

The range end value of an Attestation condition.

startOfRange

int64

The minutes after shift start to define the start of time-frame from shift start to look for punches.

extendedRadius

int64

The additional radius value to check that passed geolocation coordinated are within Known Place associated with attestation condition.

minutesAfterScheduledShiftStart

int64

The number of minutes to look for a punch after scheduled shift start.

operator

object

Key with ID and name for the Metadata Driven User Interface (MDUI).

minutesAfterScheduledShiftEnd

int64

The number of minutes to look for a punch after scheduled shift end.

type

object

Key with ID and name for the Metadata Driven User Interface (MDUI).

conditionNotEvaluated

boolean

A Boolean value that used for attestation evaluation when geolocation data not transferred in request or Known Place is no longer exist.

completedTransaction

boolean

A Boolean indicator of whether or not to ignore incomplete or timed-out transactions.

singleValue

int64

The value of an Attestation condition.

int64

The ID of an Abstract Attestation entity.

minutesBeforeScheduledShiftEnd

int64

The number of minutes to look for a punch before scheduled shift end.

versionCount

int64

The version count of an Abstract Attestation entity.

endOfRange

int64

The minutes after shift start to define the end of time-frame from shift start to look for punches.

periodicPositiveValue

string

The positive answer of the question posed. This value should represent the full name of the question exactly as it appears on the form.

conditions

array of objects

The list of Attestation combined conditions of an Attestation condition.

conditions

object

logicalOperator

string

The logical operator of an Attestation combined condition.

orderNumber

int32

The order number of an Attestation combined condition.

versionCount

int64

The version count of an Abstract Attestation entity.

attestationCondition

object

The object reference model which contains an ID and qualifier.

int64

The ID of an Abstract Attestation entity.

isNegativeOperator

boolean

periodicConditionResponseValue

string

minutesBeforeScheduledShiftStart

int64

The number of minutes to look for a punch before scheduled shift start.

deleted

boolean

A Boolean indicator of whether or not this Attestation entity has been deleted.

periodicConditionMinuteType

boolean

A Boolean indicator of whether or not to display the periodic condition day type in minutes. If false, the day type is displayed in days.

includeCompletedShifts

boolean

A Boolean indicator of whether or not to take completed shifts into consideration during minutes worked attestation condition calculation.

trueOnNoStartPunch

boolean

A Boolean indicator of whether or not no shift start punch is found. When false, a start punch was found.

minutesAfterPunch

int64

The margin after punch in minutes.

minShiftLength

int64

The minimum shift length in minutes for attestation condition of type Scheduled Shift.

periodicQuestion

string

The question text that is displayed on the associated form.

knownPlace

object

ObjectRef contains an id and qualifier and either field should be able to uniquely identify an Object

periodicConditionValue

int64

The value of an Attestation periodic condition.

minutesBeforePunch

int64

The margin before punch in minutes.

maxShiftLength

int64

The maximum shift length in minutes for attestation condition of type Scheduled Shift.

name

string

The name of an Attestation entity.

rangeValueStart

int64

The range start value of an Attestation condition.

noShiftInProgress

boolean

A Boolean indicator of whether or not to evaluate both not in progress and in progress shifts or only in progress shifts for attestation condition of Scheduled Shift type and Punches against scheduled shift.

excludeBreaksFromMinutesWorked

boolean

A Boolean indicator of whether or not to exclude breaks from minutes worked.

noScheduledShiftFound

boolean

A Boolean value to evaluate attestation when attestation condition of type Scheduled Shift and Shift Length operator and no scheduled shift found for work shift.

versionCount

int64

The version count of an Abstract Attestation entity.

orderNumber

int32

punchButtonTemplateMapping

object

ObjectRef contains an id and qualifier and either field should be able to uniquely identify an Object

int64

Object Ref Id

qualifier

string

Object Ref Unique qualifier

manualTimeEntryTemplateMapping

object

ObjectRef contains an id and qualifier and either field should be able to uniquely identify an Object

int64

Object Ref Id

qualifier

string

Object Ref Unique qualifier

attestationButton

object

The Attestation button model.

collectBeforeAttestation

boolean

A Boolean indicator of whether or not to collect before Attestation for an Attestation button.

description

string

The description of an Attestation button.

subType

object

Key with ID and name for the Metadata Driven User Interface (MDUI).

deleted

boolean

A Boolean indicator of whether or not this Attestation entity has been deleted.

versionCount

int64

The version count of an Abstract Attestation entity.

buttonType

object

Key with ID and name for the Metadata Driven User Interface (MDUI).

devicePositionSelectionAllowed

boolean

A Boolean indicator of whether or not Assignments selection is allowed at a device.

displayType

object

Key with ID and name for the Metadata Driven User Interface (MDUI).

offlineWorkflow

object

The Attestation Workflow model.

timecardApprovalTimeframe

object

Model for date range.

deviceTransferAllowed

boolean

A Boolean indicator of whether or not a transfer is allowed at a device.

int64

The ID of an Abstract Attestation entity.

offlineQuestion

object

The Attestation question model.

name

string

The name of an Attestation entity.

int64

The ID of an Abstract Attestation entity.

403

The current user does not have the permissions necessary to perform that operation.

404

An attestation assignment with the specified ID was not found.

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/api/v1/timekeeping/attestation_assignments/id \
3
     --header 'accept: application/json'

Choose an example:

application/json

200Successfully retrieved an Attestation assignment by ID.