Update a time transaction type
patch
/fscmRestApi/resources/11.13.18.05/publicSectorTimeTransactionTypes/{TransactionTypeKey}
Request
Path Parameters
-
TransactionTypeKey(required): integer(int64)
The unique identifier for the time transaction type.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AllowOverrideFlag: boolean
Title:
Override
Maximum Length:1
Indicates whether the time recording entry associated with this time transaction type allows override. -
AssessNowFlag: boolean
Title:
Assess Now
Maximum Length:1
Default Value:false
Indicates whether the time recording entry associated with the time transaction type will be assessed immediately for any fees. This can be turned on only if the time transaction type is billable. -
BillableFlag: boolean
Title:
Billable
Maximum Length:1
Indicates whether the time recording entry associated with the time transcation type is billable by default. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the time transcation type is enabled when creating a time recording entry.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : publicSectorTimeTransactionTypes-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier for the public sector agency associated with the time transaction type. -
AllowOverrideFlag: boolean
Title:
Override
Maximum Length:1
Indicates whether the time recording entry associated with this time transaction type allows override. -
AssessNowFlag: boolean
Title:
Assess Now
Maximum Length:1
Default Value:false
Indicates whether the time recording entry associated with the time transaction type will be assessed immediately for any fees. This can be turned on only if the time transaction type is billable. -
BillableFlag: boolean
Title:
Billable
Maximum Length:1
Indicates whether the time recording entry associated with the time transcation type is billable by default. -
CategoryId: string
Title:
Category
Maximum Length:30
The unique identifier of the time category that the time transaction type is used for. -
Classification: string
Title:
Classification
Maximum Length:10
The record classification that the time transaction type is used on. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date on which the time transaction type was created. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the time transcation type is enabled when creating a time recording entry. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date on which the time transaction type was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SubcategoryId: string
Title:
Subcategory
Maximum Length:30
The unique identifier of the time subcategory that the time transaction type is used for. -
TransactionType: string
Title:
Transaction
Maximum Length:10
The record transactions that the time transcation type is used on. -
TransactionTypeCode: string
Title:
Time Type Code
Maximum Length:30
The alternate unique identifier for the time transcation type. -
TransactionTypeKey: integer
(int64)
The unique identifier for the time transaction type.
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.