Jump to

• Request
• Response

Update a fund

patch

/fscmRestApi/resources/11.13.18.05/publicSectorFunds/{publicSectorFundsUniqID}

Request

Supported Media Types

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

Path Parameters

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

Body ()

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

Root Schema : publicSectorFunds-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency associated with the fund. Value is mandatory and is set programmatically based on the user's login.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date and time the fund was created.
• Description(optional): string
  Maximum Length: 100

  The first day the value may be used.
• FundId(optional): string
  Maximum Length: 30

  The unique identifier of the fund. Identifies the source or target of funding for an accounting transaction. Value is mandatory and is defined by the user during a create action.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

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

  Link Relations
• ValidFromDate(optional): string(date-time)
  The last day the value may be used.
• ValidToDate(optional): string(date-time)
  The description of the fund.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The unique identifier of the agency associated with the fund. Value is mandatory and is set programmatically based on the user's login.",
            "type":"integer",
            "format":"int32"
        },
        "CreatedBy":{
            "title":"Created By",
            "description":"The user who created the fund.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date and time the fund was created.",
            "type":"string",
            "format":"date-time"
        },
        "Description":{
            "description":"The first day the value may be used.",
            "type":"string",
            "maxLength":100
        },
        "FundId":{
            "description":"The unique identifier of the fund. Identifies the source or target of funding for an accounting transaction. Value is mandatory and is defined by the user during a create action.",
            "type":"string",
            "maxLength":30
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "description":"The date and time the fund was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "description":"The user who last updated the fund.",
            "type":"string",
            "maxLength":64
        },
        "ValidFromDate":{
            "description":"The last day the value may be used.",
            "type":"string",
            "format":"date-time"
        },
        "ValidToDate":{
            "description":"The description of the fund.",
            "type":"string",
            "format":"date-time"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

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 : publicSectorFunds-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency associated with the fund. Value is mandatory and is set programmatically based on the user's login.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date and time the fund was created.
• Description(optional): string
  Maximum Length: 100

  The first day the value may be used.
• FundId(optional): string
  Maximum Length: 30

  The unique identifier of the fund. Identifies the source or target of funding for an accounting transaction. Value is mandatory and is defined by the user during a create action.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

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

  Link Relations
• ValidFromDate(optional): string(date-time)
  The last day the value may be used.
• ValidToDate(optional): string(date-time)
  The description of the fund.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The unique identifier of the agency associated with the fund. Value is mandatory and is set programmatically based on the user's login.",
            "type":"integer",
            "format":"int32"
        },
        "CreatedBy":{
            "title":"Created By",
            "description":"The user who created the fund.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date and time the fund was created.",
            "type":"string",
            "format":"date-time"
        },
        "Description":{
            "description":"The first day the value may be used.",
            "type":"string",
            "maxLength":100
        },
        "FundId":{
            "description":"The unique identifier of the fund. Identifies the source or target of funding for an accounting transaction. Value is mandatory and is defined by the user during a create action.",
            "type":"string",
            "maxLength":30
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "description":"The date and time the fund was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "description":"The user who last updated the fund.",
            "type":"string",
            "maxLength":64
        },
        "ValidFromDate":{
            "description":"The last day the value may be used.",
            "type":"string",
            "format":"date-time"
        },
        "ValidToDate":{
            "description":"The description of the fund.",
            "type":"string",
            "format":"date-time"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

Back to Top