Update an accounting rule field value
patch
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleFieldValues/{publicSectorAccountingRuleFieldValuesUniqID}
Request
Path Parameters
-
publicSectorAccountingRuleFieldValuesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId, AccountingRuleId, EffectiveStartDate, EffectiveEndDate, FieldName and Fieldvalue ---for the Accounting Rule Field Values resource and used to uniquely identify an instance of Accounting Rule Field Values. The client should not generate the hash key value. Instead, the client should query on the Accounting Rule Field Values collection resource with a filter on the primary key values in order to navigate to a specific instance of Accounting Rule Field Values.
For example: publicSectorAccountingRuleFieldValues?q=AgencyId=<value1>;AccountingRuleId=<value2>;EffectiveStartDate=<value3>;EffectiveEndDate=<value4>;FieldName=<value5>;Fieldvalue=<value6>
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
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
The last day that the rule field value may be used. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
The first day that the rule field value may be used. -
FieldName: string
Title:
Field Name
Maximum Length:30
The field for which a value is specified by the user to control which accounting transactions are processed by the rule. -
Fieldvalue: string
Title:
Field Value
Maximum Length:200
The field value which, along with any other field values specified, determines which accounting transactions are processed by the rule.
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 : publicSectorAccountingRuleFieldValues-item-response
Type:
Show Source
object
-
AccountingRuleId: string
Title:
Accounting Rule
Maximum Length:50
The unique identifier of the accounting rule. Describes how accounting journal entries are created for a specific type of transaction. Value is mandatory and is defined by the user during a create action. -
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency associated with the accounting rule. Value is mandatory and is set programmatically based on the user's login. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the accounting rule field value. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time that the accounting rule field value was created. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
The last day that the rule field value may be used. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
The first day that the rule field value may be used. -
FieldName: string
Title:
Field Name
Maximum Length:30
The field for which a value is specified by the user to control which accounting transactions are processed by the rule. -
Fieldvalue: string
Title:
Field Value
Maximum Length:200
The field value which, along with any other field values specified, determines which accounting transactions are processed by the rule. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time that the accounting rule field value was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the accounting rule field value. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.