Create a time recording entry
post
/fscmRestApi/resources/11.13.18.05/publicSectorTimeRecordingEntries
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
The identifier for the public sector agency associated with the time recording entry.
-
AssessNow: boolean
Title:
Assess Now
Indicates that the time recording entry will be assessed immediately for any fees. This can only be turned on if the time recording entry is billable. -
BillableFlag: boolean
Title:
Billable
Maximum Length:1
Indicates whether or not the time recording entry is billable. -
Comments: string
Title:
Comments
Maximum Length:4000
The comments entered for this time recording entry. -
FeeCalcStatus: string
Maximum Length:
1
The status of the last DMN fee calculation. -
OverrideBillRate: number
Title:
Override Bill Rate
The hourly billing rate used to override the default billing rate for this time entry. -
ParentKey: integer
(int64)
The unique identifier for the parent transaction, or classification-level transaction associated with the time recording entry. For example, Permit.
-
ParentPuid: string
Maximum Length:
480
The public unique identifier for the parent transaction. -
PersonId: integer
(int64)
Title:
Name
The unique identifier for the agency staff associated with the time recording entry. -
PersonPuid: string
The public unique identifier for the agency staff associated with the time recording entry.
-
RecordedDate: string
(date)
Title:
Date
The date when the entered time occurred. -
RecordedHours: integer
(int32)
Title:
Hours
The number of hours recorded for this time entry. This can be between 0 and 23 hours. -
RecordedMinutes: integer
(int32)
Title:
Minutes
The number of minutes recorded for this time entry. This can be between 0 and 59 minutes. -
TeEntryKey: integer
(int64)
The unique identifier for the time recording entry.
-
TeEntryPuid: string
Maximum Length:
480
The public unique identifier for the time recording entry. -
TransactionKey: integer
(int64)
The unique identifier for the child transaction associated with the time recording entry. For example, Inspection.
-
TransactionPuid: string
Maximum Length:
480
The public unique identifier for the child transaction. -
TransactionSource: string
Title:
Transaction
Maximum Length:3
A code representing the type of child transaction to which the time recording entry is associated. For example, INS for inspection. -
TransactionTypeCode: string
Title:
Time Type Code
Maximum Length:30
The public unique identifier for the time entry type. -
TransactionTypeKey: integer
(int64)
Title:
Time Type Code
The unique identifier for the time entry type associated with the time recording entry.
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.
Root Schema : publicSectorTimeRecordingEntries-item-response
Type:
Show Source
object
-
AgencyId: integer
The identifier for the public sector agency associated with the time recording entry.
-
AssessNow: boolean
Title:
Assess Now
Indicates that the time recording entry will be assessed immediately for any fees. This can only be turned on if the time recording entry is billable. -
BillableFlag: boolean
Title:
Billable
Maximum Length:1
Indicates whether or not the time recording entry is billable. -
BillRate: number
Title:
Bill Rate
Read Only:true
The hourly billing rate used for this time entry. -
Comments: string
Title:
Comments
Maximum Length:4000
The comments entered for this time recording entry. -
FeeCalcStatus: string
Maximum Length:
1
The status of the last DMN fee calculation. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OverrideBillRate: number
Title:
Override Bill Rate
The hourly billing rate used to override the default billing rate for this time entry. -
ParentKey: integer
(int64)
The unique identifier for the parent transaction, or classification-level transaction associated with the time recording entry. For example, Permit.
-
ParentPuid: string
Maximum Length:
480
The public unique identifier for the parent transaction. -
PersonId: integer
(int64)
Title:
Name
The unique identifier for the agency staff associated with the time recording entry. -
PersonPuid: string
The public unique identifier for the agency staff associated with the time recording entry.
-
RecordedDate: string
(date)
Title:
Date
The date when the entered time occurred. -
RecordedHours: integer
(int32)
Title:
Hours
The number of hours recorded for this time entry. This can be between 0 and 23 hours. -
RecordedMinutes: integer
(int32)
Title:
Minutes
The number of minutes recorded for this time entry. This can be between 0 and 59 minutes. -
TeEntryKey: integer
(int64)
The unique identifier for the time recording entry.
-
TeEntryPuid: string
Maximum Length:
480
The public unique identifier for the time recording entry. -
TimeRecordedUpdateDate: string
(date-time)
Read Only:
true
The date and time when the time recording entry was last updated. -
TransactionKey: integer
(int64)
The unique identifier for the child transaction associated with the time recording entry. For example, Inspection.
-
TransactionPuid: string
Maximum Length:
480
The public unique identifier for the child transaction. -
TransactionSource: string
Title:
Transaction
Maximum Length:3
A code representing the type of child transaction to which the time recording entry is associated. For example, INS for inspection. -
TransactionTypeCode: string
Title:
Time Type Code
Maximum Length:30
The public unique identifier for the time entry type. -
TransactionTypeKey: integer
(int64)
Title:
Time Type Code
The unique identifier for the time entry type associated with the time recording entry.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.