Jump to

• Request
• Response

Update an account

patch

/fscmRestApi/resources/11.13.18.05/publicSectorAccounts/{publicSectorAccountsUniqID}

Request

Supported Media Types

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

Path Parameters

• publicSectorAccountsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- AgencyId and Account ---for the Accounts resource and used to uniquely identify an instance of Accounts. The client should not generate the hash key value. Instead, the client should query on the Accounts collection resource with a filter on the primary key values in order to navigate to a specific instance of Accounts.
  
  For example: publicSectorAccounts?q=AgencyId=<value1>;Account=<value2>

Body ()

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

Root Schema : publicSectorAccounts-item

Type: object

Show Source

• Account(optional): string
  Title: Account

  Maximum Length: 30

  The unique identifier of the account. Identifies the type of economic activity associated with an accounting transaction. Value is mandatory and is defined by the user during a create action.
• AccountType(optional): string
  Title: Account Type

  Maximum Length: 1

  The type of account. A list of accepted values is defined in the lookup type ORA_PSC_CC_ACCOUNT_TYPE.
• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency associated with the account. Value is mandatory.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date and time the account was created.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The description of the account.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

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

  Link Relations
• ValidFromDate(optional): string(date-time)
  Title: From Date

  The first day the value may be used.
• ValidToDate(optional): string(date-time)
  Title: To Date

  The last day the value may be used.

{
    "properties":{
        "Account":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the account. Identifies the type of economic activity associated with an accounting transaction. Value is mandatory and is defined by the user during a create action.",
            "title":"Account"
        },
        "AccountType":{
            "maxLength":1,
            "type":"string",
            "description":"The type of account. A list of accepted values is defined in the lookup type ORA_PSC_CC_ACCOUNT_TYPE.",
            "title":"Account Type"
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the account. Value is mandatory.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the account.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the account was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the account.",
            "title":"Description"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the account was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the account.",
            "title":"Last Updated By"
        },
        "ValidFromDate":{
            "format":"date-time",
            "type":"string",
            "description":"The first day the value may be used.",
            "title":"From Date"
        },
        "ValidToDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last day the value may be used.",
            "title":"To Date"
        },
        "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 : publicSectorAccounts-item

Type: object

Show Source

• Account(optional): string
  Title: Account

  Maximum Length: 30

  The unique identifier of the account. Identifies the type of economic activity associated with an accounting transaction. Value is mandatory and is defined by the user during a create action.
• AccountType(optional): string
  Title: Account Type

  Maximum Length: 1

  The type of account. A list of accepted values is defined in the lookup type ORA_PSC_CC_ACCOUNT_TYPE.
• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency associated with the account. Value is mandatory.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date and time the account was created.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The description of the account.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

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

  Link Relations
• ValidFromDate(optional): string(date-time)
  Title: From Date

  The first day the value may be used.
• ValidToDate(optional): string(date-time)
  Title: To Date

  The last day the value may be used.

{
    "properties":{
        "Account":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the account. Identifies the type of economic activity associated with an accounting transaction. Value is mandatory and is defined by the user during a create action.",
            "title":"Account"
        },
        "AccountType":{
            "maxLength":1,
            "type":"string",
            "description":"The type of account. A list of accepted values is defined in the lookup type ORA_PSC_CC_ACCOUNT_TYPE.",
            "title":"Account Type"
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the account. Value is mandatory.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the account.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the account was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the account.",
            "title":"Description"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the account was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the account.",
            "title":"Last Updated By"
        },
        "ValidFromDate":{
            "format":"date-time",
            "type":"string",
            "description":"The first day the value may be used.",
            "title":"From Date"
        },
        "ValidToDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last day the value may be used.",
            "title":"To Date"
        },
        "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