Jump to

• Request
• Response

Update an accounting event field

patch

/fscmRestApi/resources/11.13.18.05/publicSectorAccountingEvents/{AccountingEventId}/child/AccountingEventFields/{AccountingEventFieldsUniqID}

Request

Path Parameters

• AccountingEventFieldsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AccountingEventId and FieldName ---for the Accounting Event Fields resource and used to uniquely identify an instance of Accounting Event Fields. The client should not generate the hash key value. Instead, the client should query on the Accounting Event Fields collection resource with a filter on the primary key values in order to navigate to a specific instance of Accounting Event Fields.
  
  For example: AccountingEventFields?q=AccountingEventId=<value1>;FieldName=<value2>
• AccountingEventId(required): string
  The unique identifier of the accounting event. Identifies a specific type of agency transaction for which accounting journals are required. Value is delivered as seed data.

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 ()

Root Schema : schema

Type: object

Show Source

• DisplayField: string
  Maximum Length: 50

  The field name displayed on the page.

{
    "type":"object",
    "properties":{
        "DisplayField":{
            "maxLength":"50",
            "type":"string",
            "description":"The field name displayed on the page.",
            "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:
  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.

Body ()

Root Schema : publicSectorAccountingEvents-AccountingEventFields-item-response

Type: object

Show Source

• AccountingEventId: string
  Title: Accounting Event

  Maximum Length: 30

  The accounting event identifier. Defined in an accounting event.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the accounting event field.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the accounting event field was created.
• DeletedFlag: boolean
  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates that seed data has been deleted. True means the data is deleted. False means the data is active. The default value is false.
• DisplayField: string
  Maximum Length: 50

  The field name displayed on the page.
• FieldDescription: string
  Title: Description

  Maximum Length: 200

  The description of the field name.
• FieldName: string
  Title: Field Name

  Maximum Length: 30

  Field name whose value defines the transactions to which the accounting event applies.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the accounting event field was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the accounting event field.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PromptField: string
  Maximum Length: 30

  The service field that is used to get the field values.
• PromptTable: string
  Maximum Length: 100

  The service name that is used to get the field values.
• RequiredFlag: boolean
  Title: Required

  Maximum Length: 1

  Indicates whether a value is required for the field name. True means required. False means not required. The default value is true.
• SeedDataLock: integer (int32)
  Read Only: true

  Default Value: 0

  Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the accounting event field.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the accounting event field 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 event field.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PromptField":{
            "maxLength":"30",
            "type":"string",
            "description":"The service field that  is used to get the field values.",
            "nullable":true,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "FieldDescription":{
            "title":"Description",
            "maxLength":"200",
            "type":"string",
            "description":"The description of the field name.",
            "nullable":false,
            "x-queryable":true
        },
        "AccountingEventId":{
            "title":"Accounting Event",
            "maxLength":"30",
            "type":"string",
            "description":"The accounting event identifier. Defined in an accounting event.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y"
            },
            "x-queryable":true
        },
        "DisplayField":{
            "maxLength":"50",
            "type":"string",
            "description":"The field name displayed on the page.",
            "nullable":false,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that seed data has been deleted. True means the data is deleted. False means the data is active. The default value is false.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a value is required for the field name. True means required. False means not required. The default value is true.",
            "nullable":false,
            "x-queryable":true
        },
        "PromptTable":{
            "maxLength":"100",
            "type":"string",
            "description":"The service name that is used to get the field values.",
            "nullable":true,
            "x-queryable":true
        },
        "FieldName":{
            "title":"Field Name",
            "maxLength":"30",
            "type":"string",
            "description":"Field name whose value defines the transactions to which the accounting event applies.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y",
                "promptValue":"Y"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the accounting event field 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