Jump to

• Request
• Response

Create an award project funding source

post

/fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectFundingSource

Request

Path Parameters

• AwardId(required): integer(int64)
  Unique identifier of the award.
• AwardProjectId(required): integer(int64)
  Unique identifier of the award project.

Header Parameters

• 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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AwardFundingSourceId: integer (int64)
  Title: Award Funding Source ID

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

  Unique identifier of the award.
• AwardProjectFundingSourceId: integer (int64)
  Unique identifier of the funding source assignment to the award project.
• FundingSourceId: integer (int64)
  Title: Funding Source ID

  Unique identifier of the funding source.
• FundingSourceName: string
  Title: Funding Source Name

  Maximum Length: 360

  Name of the funding source.
• FundingSourceNumber: string
  Title: Funding Source Number

  Maximum Length: 50

  Number of the funding source, entered by the user.
• InternalFundingSourceBurdeningFlag: boolean
  Maximum Length: 1

  Enable or disable Burdening for the Internal Funding Source.

{
    "type":"object",
    "properties":{
        "FundingSourceNumber":{
            "title":"Funding Source Number",
            "maxLength":"50",
            "type":"string",
            "description":"Number of the funding source, entered by the user.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "FundingSourceId":{
            "title":"Funding Source ID",
            "type":"integer",
            "description":"Unique identifier of the funding source.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            }
        },
        "AwardFundingSourceId":{
            "title":"Award Funding Source ID",
            "type":"integer",
            "description":"Unique identifier of the award funding source.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            }
        },
        "AwardProjectFundingSourceId":{
            "type":"integer",
            "description":"Unique identifier of the funding source assignment to the award project.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "InternalFundingSourceBurdeningFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Enable or disable Burdening for the Internal Funding Source.",
            "nullable":true
        },
        "AwardId":{
            "title":"Award ID",
            "type":"integer",
            "description":"Unique identifier of the award.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "FundingSourceName":{
            "title":"Funding Source Name",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the funding source.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        }
    }
}

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-AwardProject-AwardProjectFundingSource-item-response

Type: object

Show Source

• AwardFundingSourceId: integer (int64)
  Title: Award Funding Source ID

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

  Unique identifier of the award.
• AwardProjectFundingSourceId: integer (int64)
  Unique identifier of the funding source assignment to the award project.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

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

  Unique identifier of the funding source.
• FundingSourceName: string
  Title: Funding Source Name

  Maximum Length: 360

  Name of the funding source.
• FundingSourceNumber: string
  Title: Funding Source Number

  Maximum Length: 50

  Number of the funding source, entered by the user.
• FundingSourceType: string
  Title: Funding Source Type

  Read Only: true

  Maximum Length: 80

  Type of the funding source.
• InternalFundingSourceBurdeningFlag: boolean
  Maximum Length: 1

  Enable or disable Burdening for the Internal Funding Source.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user that last updated the award project funding source.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the award project funding source was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FundingSourceType":{
            "title":"Funding Source Type",
            "maxLength":"80",
            "type":"string",
            "description":"Type of the funding source.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AwardFundingSourceId":{
            "title":"Award Funding Source ID",
            "type":"integer",
            "description":"Unique identifier of the award funding source.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user that created the award project funding source.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AwardProjectFundingSourceId":{
            "type":"integer",
            "description":"Unique identifier of the funding source assignment to the award project.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AwardId":{
            "title":"Award ID",
            "type":"integer",
            "description":"Unique identifier of the award.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FundingSourceName":{
            "title":"Funding Source Name",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the funding source.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "FundingSourceNumber":{
            "title":"Funding Source Number",
            "maxLength":"50",
            "type":"string",
            "description":"Number of the funding source, entered by the user.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "FundingSourceId":{
            "title":"Funding Source ID",
            "type":"integer",
            "description":"Unique identifier of the funding source.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "InternalFundingSourceBurdeningFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Enable or disable Burdening for the Internal Funding Source.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the award project funding source was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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