Jump to

• Request
• Response

Update an accounting event field

patch

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

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• AccountingEventFieldsUniqID: integer
  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: 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.

Body ()

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

Root Schema : publicSectorAccountingEvents-AccountingEventFields-item

Type: object

Show Source

• AccountingEventId(optional): string
  Title: Accounting Event

  Maximum Length: 30

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

  Maximum Length: 64

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

  The date and time when the accounting event field was created.
• DeletedFlag(optional): boolean
  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(optional): string
  Maximum Length: 50

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

  Maximum Length: 200

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

  Maximum Length: 30

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

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

  Maximum Length: 64

  The user who last updated the accounting event field.
• links(optional): array Items
  Title: Items

  Link Relations
• PromptField(optional): string
  Maximum Length: 30

  The service field that is used to get the field values.
• PromptTable(optional): string
  Maximum Length: 30

  The service name that is used to get the field values.
• RequiredFlag(optional): string
  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(optional): integer(int32)
  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.

{
    "properties":{
        "AccountingEventId":{
            "maxLength":30,
            "type":"string",
            "description":"The accounting event identifier. Defined in an accounting event.",
            "title":"Accounting Event"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the accounting event field.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the accounting event field was created.",
            "title":"Creation Date"
        },
        "DeletedFlag":{
            "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."
        },
        "DisplayField":{
            "maxLength":50,
            "type":"string",
            "description":"The field name displayed on the page."
        },
        "FieldDescription":{
            "maxLength":200,
            "type":"string",
            "description":"The description of the field name.",
            "title":"Description"
        },
        "FieldName":{
            "maxLength":30,
            "type":"string",
            "description":"Field name whose value defines the transactions to which the accounting event applies.",
            "title":"Field Name"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the accounting event field was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the accounting event field.",
            "title":"Last Updated By"
        },
        "PromptField":{
            "maxLength":30,
            "type":"string",
            "description":"The service field that  is used to get the field values."
        },
        "PromptTable":{
            "maxLength":30,
            "type":"string",
            "description":"The service name that is used to get the field values."
        },
        "RequiredFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a value is required for the field name. True means required. False means not required. The default value is true.",
            "title":"Required"
        },
        "SeedDataLock":{
            "format":"int32",
            "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."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorAccountingEvents-AccountingEventFields-item

Type: object

Show Source

• AccountingEventId(optional): string
  Title: Accounting Event

  Maximum Length: 30

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

  Maximum Length: 64

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

  The date and time when the accounting event field was created.
• DeletedFlag(optional): boolean
  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(optional): string
  Maximum Length: 50

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

  Maximum Length: 200

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

  Maximum Length: 30

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

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

  Maximum Length: 64

  The user who last updated the accounting event field.
• links(optional): array Items
  Title: Items

  Link Relations
• PromptField(optional): string
  Maximum Length: 30

  The service field that is used to get the field values.
• PromptTable(optional): string
  Maximum Length: 30

  The service name that is used to get the field values.
• RequiredFlag(optional): string
  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(optional): integer(int32)
  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.

{
    "properties":{
        "AccountingEventId":{
            "maxLength":30,
            "type":"string",
            "description":"The accounting event identifier. Defined in an accounting event.",
            "title":"Accounting Event"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the accounting event field.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the accounting event field was created.",
            "title":"Creation Date"
        },
        "DeletedFlag":{
            "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."
        },
        "DisplayField":{
            "maxLength":50,
            "type":"string",
            "description":"The field name displayed on the page."
        },
        "FieldDescription":{
            "maxLength":200,
            "type":"string",
            "description":"The description of the field name.",
            "title":"Description"
        },
        "FieldName":{
            "maxLength":30,
            "type":"string",
            "description":"Field name whose value defines the transactions to which the accounting event applies.",
            "title":"Field Name"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the accounting event field was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the accounting event field.",
            "title":"Last Updated By"
        },
        "PromptField":{
            "maxLength":30,
            "type":"string",
            "description":"The service field that  is used to get the field values."
        },
        "PromptTable":{
            "maxLength":30,
            "type":"string",
            "description":"The service name that is used to get the field values."
        },
        "RequiredFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a value is required for the field name. True means required. False means not required. The default value is true.",
            "title":"Required"
        },
        "SeedDataLock":{
            "format":"int32",
            "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."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top