Jump to

• Request
• Response

Update an award funding source

patch

/fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardFundingSource/{AwardFundingSourceUniqID}

Request

Path Parameters

• AwardFundingSourceUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Award Funding Sources resource and used to uniquely identify an instance of Award Funding Sources. The client should not generate the hash key value. Instead, the client should query on the Award Funding Sources collection resource in order to navigate to a specific instance of Award Funding Sources to get the hash key.
• AwardId(required): integer(int64)
  Unique identifier of the award.

Header Parameters

• Effective-Of: string
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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

• ApprovalDate: string (date)
  Title: Approval Date

  The approval date of the selected award funding source.
• ApprovalPersonId: integer (int64)
  Title: Approved By

  The unique identifier of the person who approved the selected funding source.
• ApprovalPersonName: string
  Title: Approved By

  Maximum Length: 240

  The name of the person who approved the selected funding source.
• ApprovalPersonNumber: string
  Title: Approval Person Number

  Maximum Length: 30

  The number of the person who approved the selected funding source.
• AwardFundingSourceSourceId: integer (int64)
  Title: Award Funding Source ID

  The unique identifier of the award funding source association.
• AwardId: integer (int64)
  Title: Award ID

  The unique identifier of the award.
• FundingSourceId: integer (int64)
  Title: Funding Source ID

  The unique identifier of the selected funding source.
• FundingSourceName: string
  Title: Name

  Maximum Length: 360

  The name of the selected funding source.
• FundingSourceNumber: string
  Title: Number

  Maximum Length: 50

  The unique number associated with the selected funding source.
• RequiredBySponsor: string
  Title: Required By Sponsor

  Maximum Length: 1

  Indicates whether the selected funding source is marked as required by sponsor.

{
    "type":"object",
    "properties":{
        "ApprovalDate":{
            "title":"Approval Date",
            "type":"string",
            "description":"The approval date of the selected award funding source.",
            "format":"date",
            "nullable":true
        },
        "ApprovalPersonId":{
            "title":"Approved By",
            "type":"integer",
            "description":"The unique identifier of the person who approved the selected funding source.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            }
        },
        "ApprovalPersonName":{
            "title":"Approved By",
            "maxLength":240,
            "type":"string",
            "description":"The name of the person who approved the selected funding source.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ApprovalPersonNumber":{
            "title":"Approval Person Number",
            "maxLength":30,
            "type":"string",
            "description":"The number of the person who approved the selected funding source.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AwardFundingSourceSourceId":{
            "title":"Award Funding Source ID",
            "type":"integer",
            "description":"The unique identifier of the award funding source association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "AwardId":{
            "title":"Award ID",
            "type":"integer",
            "description":"The unique identifier of the award.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "FundingSourceId":{
            "title":"Funding Source ID",
            "type":"integer",
            "description":"The unique identifier of the selected funding source.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "FundingSourceName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the selected funding source.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "FundingSourceNumber":{
            "title":"Number",
            "maxLength":50,
            "type":"string",
            "description":"The unique number associated with the selected funding source.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "RequiredBySponsor":{
            "title":"Required By Sponsor",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the selected funding source is marked as required by sponsor.",
            "nullable":true
        }
    }
}

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 : awards-AwardFundingSource-item-response

Type: object

Show Source

• ApprovalDate: string (date)
  Title: Approval Date

  The approval date of the selected award funding source.
• ApprovalPersonId: integer (int64)
  Title: Approved By

  The unique identifier of the person who approved the selected funding source.
• ApprovalPersonName: string
  Title: Approved By

  Maximum Length: 240

  The name of the person who approved the selected funding source.
• ApprovalPersonNumber: string
  Title: Approval Person Number

  Maximum Length: 30

  The number of the person who approved the selected funding source.
• AwardFundingSourceSourceId: integer (int64)
  Title: Award Funding Source ID

  The unique identifier of the award funding source association.
• AwardId: integer (int64)
  Title: Award ID

  The unique identifier of the award.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user that created the award funding source.
• CreationDate: string (date-time)
  Read Only: true

  The date when the award funding source was created.
• FundingSourceId: integer (int64)
  Title: Funding Source ID

  The unique identifier of the selected funding source.
• FundingSourceName: string
  Title: Name

  Maximum Length: 360

  The name of the selected funding source.
• FundingSourceNumber: string
  Title: Number

  Maximum Length: 50

  The unique number associated with the selected funding source.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the award funding source was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user that last updated the award funding source.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RequiredBySponsor: string
  Title: Required By Sponsor

  Maximum Length: 1

  Indicates whether the selected funding source is marked as required by sponsor.
• Type: string
  Title: Type

  Read Only: true

  Maximum Length: 1

  The type of the selected award funding source.

{
    "type":"object",
    "properties":{
        "ApprovalDate":{
            "title":"Approval Date",
            "type":"string",
            "description":"The approval date of the selected award funding source.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ApprovalPersonId":{
            "title":"Approved By",
            "type":"integer",
            "description":"The unique identifier of the person who approved the selected funding source.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "ApprovalPersonName":{
            "title":"Approved By",
            "maxLength":240,
            "type":"string",
            "description":"The name of the person who approved the selected funding source.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ApprovalPersonNumber":{
            "title":"Approval Person Number",
            "maxLength":30,
            "type":"string",
            "description":"The number of the person who approved the selected funding source.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "AwardFundingSourceSourceId":{
            "title":"Award Funding Source ID",
            "type":"integer",
            "description":"The unique identifier of the award funding source association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AwardId":{
            "title":"Award ID",
            "type":"integer",
            "description":"The unique identifier of the award.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user that created the award funding source.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the award funding source was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FundingSourceId":{
            "title":"Funding Source ID",
            "type":"integer",
            "description":"The unique identifier of the selected funding source.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FundingSourceName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the selected funding source.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "FundingSourceNumber":{
            "title":"Number",
            "maxLength":50,
            "type":"string",
            "description":"The unique number associated with the selected funding source.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the award funding source was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user that last updated the award funding source.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredBySponsor":{
            "title":"Required By Sponsor",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the selected funding source is marked as required by sponsor.",
            "nullable":true,
            "x-queryable":true
        },
        "Type":{
            "title":"Type",
            "maxLength":1,
            "type":"string",
            "description":"The type of the selected award funding source.",
            "nullable":false,
            "readOnly":true,
            "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