Get a sponsor
get
/fscmRestApi/resources/11.13.18.05/grantsSponsors/{SponsorId}
Request
Path Parameters
-
SponsorId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 Schedule
Maximum Length:30
The name of the burden schedule. -
Comments: string
Maximum Length:
2000
The comments about the sponsor. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Created By -
CreationDate: string
(date-time)
Read Only:
true
Creation Date -
FederalFlag: boolean
Maximum Length:
1
Indicates whether the sponsor billing is federal. -
GrantsSponsorAccountDetails: array
Grants Sponsor Account Details
Title:
Grants Sponsor Account Details
The Grants Sponsor Account Details resource is used to get the details of the sponsor account. -
grantsSponsorReferenceTypes: array
Sponsor Reference Types
Title:
Sponsor Reference Types
The Grants Sponsor Reference Types resource is used to get sponsor reference types. -
LastUpdateDate: string
(date-time)
Read Only:
true
Last Updated By -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Last Updated Date -
LetterOfCreditFlag: boolean
Maximum Length:
1
Indicates whether the sponsor billing is letter of credit. -
LetterOfCreditNumber: string
Maximum Length:
240
The unique number of the sponsor letter of credit. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
The unique party identifier of the sponsor.
-
PrimaryContactAddresss: string
Title:
Primary Address
Read Only:true
The primary contact address of the sponsor. -
PrimaryContactEmail: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The primary contact email address of the sponsor. -
PrimaryContactName: string
Title:
Name
Read Only:true
Maximum Length:360
The primary contact name of the sponsor. -
PrimaryContactPhone: string
Title:
Primary Phone
Read Only:true
The primary contact phone number of the sponsor. -
PrimaryURL: string
Title:
Primary URL
Read Only:true
Maximum Length:2000
The primary URL of the sponsor. -
RelatedSponsorAccountId: integer
(int64)
The unique identifier of the related sponsor account.
-
RelatedSponsorAccountName: string
Maximum Length:
255
The name of the related sponsor account. -
RelatedSponsorAccountNumber: string
Maximum Length:
255
The unique number of the related sponsor account. -
RelatedSponsorId: integer
(int64)
The unique identifier of the related sponsor.
-
RelatedSponsorName: string
Maximum Length:
255
The name of the related sponsor. -
RelatedSponsorNumber: string
Maximum Length:
255
The unique number of the related sponsor. -
SponsorAccountId: integer
(int64)
Title:
Sponsor Account Number
Default Value:0
The unique identifier of the sponsor account. -
SponsorAccountName: string
Maximum Length:
255
The name of the sponsor account. -
SponsorAccountNumber: string
Maximum Length:
255
The unique number of the sponsor account. -
SponsorId: integer
(int64)
The unique identifier of the sponsor.
-
SponsorName: string
Title:
Sponsor Name
Maximum Length:360
The name of the sponsor. -
SponsorNumber: string
Title:
Sponsor Number
Maximum Length:30
The unique number of the sponsor. -
Status: string
Title:
Status
Read Only:true
Maximum Length:80
The status of the sponsor. -
StatusCode: string
Title:
Party Status
Read Only:true
Maximum Length:1
The status code of the sponsor.
Nested Schema : Grants Sponsor Account Details
Type:
array
Title:
Grants Sponsor Account Details
The Grants Sponsor Account Details resource is used to get the details of the sponsor account.
Show Source
Nested Schema : Sponsor Reference Types
Type:
array
Title:
Sponsor Reference Types
The Grants Sponsor Reference Types resource is used to get sponsor reference types.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : grantsSponsors-GrantsSponsorAccountDetails-item-response
Type:
Show Source
object
-
Comments: string
Maximum Length:
2000
The comment about the sponsor account details. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Created By -
CreationDate: string
(date-time)
Read Only:
true
Creation Date -
LastUpdateDate: string
(date-time)
Read Only:
true
Last Updated Date -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Last Updated By -
LetterOfCreditFlag: boolean
Maximum Length:
1
Indicates whether the sponsor billing is letter of credit. -
LetterOfCreditNumber: string
Maximum Length:
240
The unique number of the sponsor letter of credit. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryFlag: boolean
Maximum Length:
1
Indicates whether the sponsor account is primary. -
RelatedSponsorAccountId: integer
(int64)
The unique identifier of the related sponsor account.
-
RelatedSponsorAccountName: string
Title:
Account Description
Maximum Length:240
The name of the related sponsor account. -
RelatedSponsorAccountNumber: string
Title:
Account Number
Maximum Length:30
The unique number of the related sponsor account. -
RelatedSponsorId: integer
(int64)
The unique identifier of the related sponsor.
-
RelatedSponsorName: string
Maximum Length:
255
The name of the related sponsor. -
RelatedSponsorNumber: string
Maximum Length:
255
The 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 Description
Maximum Length:240
The name of the sponsor account. -
SponsorAccountNumber: string
Title:
Account Number
Maximum Length:30
The unique number of the sponsor account. -
SponsorId: integer
(int64)
The unique identifier of the sponsor.
-
SponsorName: string
Maximum Length:
255
The name of the sponsor. -
SponsorNumber: string
Maximum Length:
255
The unique number of the sponsor.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
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:
Comments
Maximum Length:2000
The comments about the sponsor reference type. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Created By -
CreationDate: string
(date-time)
Read Only:
true
Creation Date -
Description: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the sponsor reference type. -
LastUpdateDate: string
(date-time)
Read Only:
true
Last Updated By -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Last Updated Date -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SponsorReferenceId: integer
(int64)
The unique identifier of the sponsor reference type.
-
SponsorReferenceType: string
Title:
Type
Maximum Length:80
The type of the sponsor reference, for example, Industry. -
SponsorReferenceValue: string
Title:
Value
Maximum Length:300
The value of the sponsor reference type, for example, State Government or Local Government.
Nested Schema : Links
Type:
array
Title:
Links
The 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 get a sponsor by submitting a GET request on the REST resource using cURL.
curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/grantsSponsors/300100038787785
Response Body Example
The following shows an example of the response body in JSON format of all project templates.
{ "SponsorId": 300100038787785, "PartyId": 300100031629043, "SponsorName": "Lian Foundation", "SponsorNumber": "CDRM_70292", "PrimaryContactName": "Nick Marsh", "PrimaryURL": null, "PrimaryContactPhone": null, "PrimaryContactAddresss": "1212,NEW YORK, NEW YORK 10013", "PrimaryContactEmail": null, "SponsorAccountId": 300100031629044, "SponsorAccountNumber": "CDRM_4106", "SponsorAccountName": "Lian Account", "FederalFlag": false, "LetterOfCreditFlag": false, "LetterOfCreditNumber": null, "Comments": null, "RelatedSponsorId": null, "RelatedSponsorName": null, "RelatedSponsorNumber": null, "RelatedSponsorAccountId": null, "RelatedSponsorAccountName": null, "RelatedSponsorAccountNumber": null, "BurdenScheduleId": 300100038787360, "BurdenScheduleName": "Award Burden Schedule", "CreatedBy": "Abraham.Mason", "CreationDate": "2014-08-06T01:53:56.162+00:00", "LastUpdatedBy": "Abraham.Mason", "LastUpdateDate": "2014-08-06T01:55:19.248+00:00", "links": [ { "rel": "self", "href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/grantsSponsors/300100038787785", "name": "grantsSponsors", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/grantsSponsors/300100038787785", "name": "grantsSponsors", "kind": "item" }, { "rel": "child", "href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/grantsSponsors/300100038787785/child/grantsSponsorReferenceTypes", "name": "grantsSponsorReferenceTypes", "kind": "collection" } ] }