Jump to

• Request
• Response

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

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Fieldvalue":{
            "title":"Field Value",
            "maxLength":200,
            "type":"string",
            "description":"The field value which, along with any other field values specified, determines which accounting transactions are processed by the rule.",
            "nullable":false
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"The last day that the rule field value may be used.",
            "format":"date",
            "nullable":false
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"The first day that the rule field value may be used.",
            "format":"date",
            "nullable":false
        },
        "FieldName":{
            "title":"Field Name",
            "maxLength":30,
            "type":"string",
            "description":"The field for which a value is specified by the user to control which accounting transactions are processed by the rule.",
            "nullable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorAccountingRuleFieldValues-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the accounting rule field value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time that the accounting rule field value was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the accounting rule field value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the accounting rule. Value is mandatory and is set programmatically based on the user's login.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"The last day that the rule field value may be used.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "AccountingRuleId":{
            "title":"Accounting Rule",
            "maxLength":50,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "Fieldvalue":{
            "title":"Field Value",
            "maxLength":200,
            "type":"string",
            "description":"The field value which, along with any other field values specified, determines which accounting transactions are processed by the rule.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"The first day that the rule field value may be used.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "FieldName":{
            "title":"Field Name",
            "maxLength":30,
            "type":"string",
            "description":"The field for which a value is specified by the user to control which accounting transactions are processed by the rule.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time that the accounting rule field value was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top