Jump to

• Request
• Response

Update a fund

patch

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

Request

Path Parameters

• publicSectorFundsUniqID(required): string
  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>

Header Parameters

• Metadata-Context: string
  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: string
  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

• Description: string
  Title: Description

  Maximum Length: 100

  The first day the value may be used.
• ValidFromDate: string (date-time)
  Title: From Date

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

  The description of the fund.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The first day the value may be used.",
            "nullable":true
        },
        "ValidFromDate":{
            "title":"From Date",
            "type":"string",
            "description":"The last day the value may be used.",
            "format":"date-time",
            "nullable":false
        },
        "ValidToDate":{
            "title":"To Date",
            "type":"string",
            "description":"The description of the fund.",
            "format":"date-time",
            "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 : publicSectorFunds-item-response

Type: object

Show Source

• AgencyId: 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: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time the fund was created.
• Description: string
  Title: Description

  Maximum Length: 100

  The first day the value may be used.
• FundId: string
  Title: Fund

  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: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who last updated the fund.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ValidFromDate: string (date-time)
  Title: From Date

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

  The description of the fund.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the fund. Value is mandatory and is set programmatically based on the user's login.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the fund.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time the fund was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The first day the value may be used.",
            "nullable":true,
            "x-queryable":true
        },
        "FundId":{
            "title":"Fund",
            "maxLength":30,
            "type":"string",
            "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.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time the fund was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the fund.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidFromDate":{
            "title":"From Date",
            "type":"string",
            "description":"The last day the value may be used.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ValidToDate":{
            "title":"To Date",
            "type":"string",
            "description":"The description of the fund.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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