Create one or many sponsors
post
/fscmRestApi/resources/11.13.18.05/grantsSponsors
Request
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
Root Schema : schema
Type:
Show Source
object-
BurdenScheduleId: integer
(int64)
The unique identifier of the burden schedule.
-
BurdenScheduleName: string
Title:
Sponsor Burden ScheduleMaximum Length:30The name of the burden schedule. -
Comments: string
Maximum Length:
2000The comments about the sponsor. -
FederalFlag: boolean
Maximum Length:
1Indicates whether the sponsor billing is federal. -
GrantsSponsorAccountDetails: array
Grants Sponsor Account Details
Title:
Grants Sponsor Account DetailsThe Grants Sponsor Account Details resource is used to get the details of the sponsor account. -
grantsSponsorReferenceTypes: array
Sponsor Reference Types
Title:
Sponsor Reference TypesThe Grants Sponsor Reference Types resource is used to get sponsor reference types. -
LetterOfCreditFlag: boolean
Maximum Length:
1Indicates whether the sponsor billing is letter of credit. -
LetterOfCreditNumber: string
Maximum Length:
240The unique number of the sponsor letter of credit. -
PartyId(required): integer
(int64)
The unique party identifier of the sponsor.
-
RelatedSponsorAccountId: integer
(int64)
The unique identifier of the related sponsor account.
-
RelatedSponsorAccountName: string
Maximum Length:
255The name of the related sponsor account. -
RelatedSponsorAccountNumber: string
Maximum Length:
255The unique number of the related sponsor account. -
RelatedSponsorId: integer
(int64)
The unique identifier of the related sponsor.
-
RelatedSponsorName: string
Maximum Length:
255The name of the related sponsor. -
RelatedSponsorNumber: string
Maximum Length:
255The unique number of the related sponsor. -
SponsorAccountId: integer
(int64)
Title:
Sponsor Account NumberDefault Value:0The unique identifier of the sponsor account. -
SponsorAccountName: string
Maximum Length:
255The name of the sponsor account. -
SponsorAccountNumber: string
Maximum Length:
255The unique number of the sponsor account. -
SponsorId: integer
(int64)
The unique identifier of the sponsor.
-
SponsorName(required): string
Title:
Sponsor NameMaximum Length:360The name of the sponsor. -
SponsorNumber(required): string
Title:
Sponsor NumberMaximum Length:30The unique number of the sponsor.
Nested Schema : Grants Sponsor Account Details
Type:
arrayTitle:
Grants Sponsor Account DetailsThe Grants Sponsor Account Details resource is used to get the details of the sponsor account.
Show Source
Nested Schema : Sponsor Reference Types
Type:
arrayTitle:
Sponsor Reference TypesThe Grants Sponsor Reference Types resource is used to get sponsor reference types.
Show Source
Nested Schema : schema
Type:
Show Source
object-
Comments: string
Maximum Length:
2000The comment about the sponsor account details. -
LetterOfCreditFlag: boolean
Maximum Length:
1Indicates whether the sponsor billing is letter of credit. -
LetterOfCreditNumber: string
Maximum Length:
240The unique number of the sponsor letter of credit. -
PrimaryFlag: boolean
Maximum Length:
1Indicates whether the sponsor account is primary. -
RelatedSponsorAccountId: integer
(int64)
The unique identifier of the related sponsor account.
-
RelatedSponsorAccountName: string
Title:
Account DescriptionMaximum Length:240The name of the related sponsor account. -
RelatedSponsorAccountNumber: string
Title:
Account NumberMaximum Length:30The unique number of the related sponsor account. -
RelatedSponsorId: integer
(int64)
The unique identifier of the related sponsor.
-
RelatedSponsorName: string
Maximum Length:
255The name of the related sponsor. -
RelatedSponsorNumber: string
Maximum Length:
255The unique number of the related sponsor. -
SponsorAccountDetailsId: integer
(int64)
The unique identifier or the sponsor account details.
-
SponsorAccountId: integer
(int64)
The unique identifier of the sponsor account.
-
SponsorAccountName: string
Title:
Account DescriptionMaximum Length:240The name of the sponsor account. -
SponsorAccountNumber: string
Title:
Account NumberMaximum Length:30The unique number of the sponsor account. -
SponsorId: integer
(int64)
The unique identifier of the sponsor.
-
SponsorName: string
Maximum Length:
255The name of the sponsor. -
SponsorNumber: string
Maximum Length:
255The unique number of the sponsor.
Nested Schema : schema
Type:
Show Source
object-
Comments: string
Title:
CommentsMaximum Length:2000The comments about the sponsor reference type. -
SponsorReferenceId: integer
(int64)
The unique identifier of the sponsor reference type.
-
SponsorReferenceType: string
Title:
TypeMaximum Length:80The type of the sponsor reference, for example, Industry. -
SponsorReferenceValue: string
Title:
ValueMaximum Length:300The value of the sponsor reference type, for example, State Government or Local Government.
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.
Root Schema : grantsSponsors-item-response
Type:
Show Source
object-
BurdenScheduleId: integer
(int64)
The unique identifier of the burden schedule.
-
BurdenScheduleName: string
Title:
Sponsor Burden ScheduleMaximum Length:30The name of the burden schedule. -
Comments: string
Maximum Length:
2000The comments about the sponsor. -
CreatedBy: string
Read Only:
trueMaximum Length:64Created By -
CreationDate: string
(date-time)
Read Only:
trueCreation Date -
FederalFlag: boolean
Maximum Length:
1Indicates whether the sponsor billing is federal. -
GrantsSponsorAccountDetails: array
Grants Sponsor Account Details
Title:
Grants Sponsor Account DetailsThe Grants Sponsor Account Details resource is used to get the details of the sponsor account. -
grantsSponsorReferenceTypes: array
Sponsor Reference Types
Title:
Sponsor Reference TypesThe Grants Sponsor Reference Types resource is used to get sponsor reference types. -
LastUpdateDate: string
(date-time)
Read Only:
trueLast Updated By -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Last Updated Date -
LetterOfCreditFlag: boolean
Maximum Length:
1Indicates whether the sponsor billing is letter of credit. -
LetterOfCreditNumber: string
Maximum Length:
240The unique number of the sponsor letter of credit. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PartyId: integer
(int64)
The unique party identifier of the sponsor.
-
PrimaryContactAddresss: string
Title:
Primary AddressRead Only:trueThe primary contact address of the sponsor. -
PrimaryContactEmail: string
Title:
Primary EmailRead Only:trueMaximum Length:320The primary contact email address of the sponsor. -
PrimaryContactName: string
Title:
NameRead Only:trueMaximum Length:360The primary contact name of the sponsor. -
PrimaryContactPhone: string
Title:
Primary PhoneRead Only:trueThe primary contact phone number of the sponsor. -
PrimaryURL: string
Title:
Primary URLRead Only:trueMaximum Length:2000The primary URL of the sponsor. -
RelatedSponsorAccountId: integer
(int64)
The unique identifier of the related sponsor account.
-
RelatedSponsorAccountName: string
Maximum Length:
255The name of the related sponsor account. -
RelatedSponsorAccountNumber: string
Maximum Length:
255The unique number of the related sponsor account. -
RelatedSponsorId: integer
(int64)
The unique identifier of the related sponsor.
-
RelatedSponsorName: string
Maximum Length:
255The name of the related sponsor. -
RelatedSponsorNumber: string
Maximum Length:
255The unique number of the related sponsor. -
SponsorAccountId: integer
(int64)
Title:
Sponsor Account NumberDefault Value:0The unique identifier of the sponsor account. -
SponsorAccountName: string
Maximum Length:
255The name of the sponsor account. -
SponsorAccountNumber: string
Maximum Length:
255The unique number of the sponsor account. -
SponsorId: integer
(int64)
The unique identifier of the sponsor.
-
SponsorName: string
Title:
Sponsor NameMaximum Length:360The name of the sponsor. -
SponsorNumber: string
Title:
Sponsor NumberMaximum Length:30The unique number of the sponsor. -
Status: string
Title:
StatusRead Only:trueMaximum Length:80The status of the sponsor. -
StatusCode: string
Title:
Party StatusRead Only:trueMaximum Length:1The status code of the sponsor.
Nested Schema : Grants Sponsor Account Details
Type:
arrayTitle:
Grants Sponsor Account DetailsThe Grants Sponsor Account Details resource is used to get the details of the sponsor account.
Show Source
Nested Schema : Sponsor Reference Types
Type:
arrayTitle:
Sponsor Reference TypesThe Grants Sponsor Reference Types resource is used to get sponsor reference types.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : grantsSponsors-GrantsSponsorAccountDetails-item-response
Type:
Show Source
object-
Comments: string
Maximum Length:
2000The comment about the sponsor account details. -
CreatedBy: string
Read Only:
trueMaximum Length:64Created By -
CreationDate: string
(date-time)
Read Only:
trueCreation Date -
LastUpdateDate: string
(date-time)
Read Only:
trueLast Updated Date -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Last Updated By -
LetterOfCreditFlag: boolean
Maximum Length:
1Indicates whether the sponsor billing is letter of credit. -
LetterOfCreditNumber: string
Maximum Length:
240The unique number of the sponsor letter of credit. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PrimaryFlag: boolean
Maximum Length:
1Indicates whether the sponsor account is primary. -
RelatedSponsorAccountId: integer
(int64)
The unique identifier of the related sponsor account.
-
RelatedSponsorAccountName: string
Title:
Account DescriptionMaximum Length:240The name of the related sponsor account. -
RelatedSponsorAccountNumber: string
Title:
Account NumberMaximum Length:30The unique number of the related sponsor account. -
RelatedSponsorId: integer
(int64)
The unique identifier of the related sponsor.
-
RelatedSponsorName: string
Maximum Length:
255The name of the related sponsor. -
RelatedSponsorNumber: string
Maximum Length:
255The unique number of the related sponsor. -
SponsorAccountDetailsId: integer
(int64)
The unique identifier or the sponsor account details.
-
SponsorAccountId: integer
(int64)
The unique identifier of the sponsor account.
-
SponsorAccountName: string
Title:
Account DescriptionMaximum Length:240The name of the sponsor account. -
SponsorAccountNumber: string
Title:
Account NumberMaximum Length:30The unique number of the sponsor account. -
SponsorId: integer
(int64)
The unique identifier of the sponsor.
-
SponsorName: string
Maximum Length:
255The name of the sponsor. -
SponsorNumber: string
Maximum Length:
255The unique number of the sponsor.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : grantsSponsors-grantsSponsorReferenceTypes-item-response
Type:
Show Source
object-
Comments: string
Title:
CommentsMaximum Length:2000The comments about the sponsor reference type. -
CreatedBy: string
Read Only:
trueMaximum Length:64Created By -
CreationDate: string
(date-time)
Read Only:
trueCreation Date -
Description: string
Title:
DescriptionRead Only:trueMaximum Length:240The description of the sponsor reference type. -
LastUpdateDate: string
(date-time)
Read Only:
trueLast Updated By -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Last Updated Date -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SponsorReferenceId: integer
(int64)
The unique identifier of the sponsor reference type.
-
SponsorReferenceType: string
Title:
TypeMaximum Length:80The type of the sponsor reference, for example, Industry. -
SponsorReferenceValue: string
Title:
ValueMaximum Length:300The value of the sponsor reference type, for example, State Government or Local Government.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- GrantsSponsorAccountDetails
-
Operation: /fscmRestApi/resources/11.13.18.05/grantsSponsors/{SponsorId}/child/GrantsSponsorAccountDetailsParameters:
- SponsorId:
$request.path.SponsorId
The Grants Sponsor Account Details resource is used to get the details of the sponsor account. - SponsorId:
- grantsSponsorReferenceTypes
-
Operation: /fscmRestApi/resources/11.13.18.05/grantsSponsors/{SponsorId}/child/grantsSponsorReferenceTypesParameters:
- SponsorId:
$request.path.SponsorId
The Grants Sponsor Reference Types resource is used to get sponsor reference types. - SponsorId:
Examples
The following example shows how to create one or many sponsors by submitting a POST request on the REST resource using cURL.
curl --user ppm_cloud_user -X POST -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/grantsSponsors
Request Body Example
The following shows an example of the request body in JSON format.
{
"PartyId": 1902598,
"SponsorAccountId": 1741555,
"grantsSponsorReferenceTypes": [{
"SponsorReferenceType": "Proposal",
"SponsorReferenceValue": "adsasdas"
}]
}Response Body Example
The following shows an example of the response body in JSON format.
{
"SponsorId": 300100185312914,
"PartyId": 1902598,
"SponsorName": "RENTAL SERVICE CORP",
"SponsorNumber": "1710220",
"PrimaryContactName": null,
"PrimaryURL": null,
"PrimaryContactPhone": "+1 ",
"PrimaryContactAddresss": "SWING RD,35128 \r\r,GREENSBORO, NC 27409",
"PrimaryContactEmail": null,
"SponsorAccountId": 1741555,
"SponsorAccountNumber": "1652231",
"SponsorAccountName": "RENTAL SERVICE CORP",
"FederalFlag": false,
"LetterOfCreditFlag": false,
"LetterOfCreditNumber": null,
"Comments": null,
"RelatedSponsorId": null,
"RelatedSponsorName": null,
"RelatedSponsorNumber": null,
"RelatedSponsorAccountId": null,
"RelatedSponsorAccountName": null,
"RelatedSponsorAccountNumber": null,
"BurdenScheduleId": null,
"BurdenScheduleName": null,
"CreatedBy": "Alice.Parker",
"CreationDate": "2020-03-31T21:19:48+00:00",
"LastUpdatedBy": "Alice.Parker",
"LastUpdateDate": "2020-03-31T21:19:48.117+00:00",
"grantsSponsorReferenceTypes": [
{
"SponsorReferenceId": 300100185312915,
"SponsorReferenceType": "Proposal",
"SponsorReferenceValue": "adsasdas",
"Description": "Proposal",
"Comments": null,
"CreatedBy": "Alice.Parker",
"CreationDate": "2020-03-31T21:19:48.066+00:00",
"LastUpdatedBy": "Alice.Parker",
"LastUpdateDate": "2020-03-31T21:19:48.411+00:00",
"links": [
{
"rel": "self",
"href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/grantsSponsors/300100185312914/child/grantsSponsorReferenceTypes/00020000000EACED00057708000110F084F14E930000000EACED00057708000110F07C35826D",
"name": "grantsSponsorReferenceTypes",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/grantsSponsors/300100185312914/child/grantsSponsorReferenceTypes/00020000000EACED00057708000110F084F14E930000000EACED00057708000110F07C35826D",
"name": "grantsSponsorReferenceTypes",
"kind": "item"
},
{
"rel": "parent",
"href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/grantsSponsors/300100185312914",
"name": "grantsSponsors",
"kind": "item"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/grantsSponsors/300100185312914",
"name": "grantsSponsors",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/grantsSponsors/300100185312914",
"name": "grantsSponsors",
"kind": "item"
},
{
"rel": "child",
"href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/grantsSponsors/300100185312914/child/grantsSponsorReferenceTypes",
"name": "grantsSponsorReferenceTypes",
"kind": "collection"
}
]
}