Jump to

• Request
• Response
• Examples

Get many sponsors

get

/fscmRestApi/resources/11.13.18.05/grantsSponsors

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds the sponsor with the specified primary key.
    Finder Variables
    • SponsorId; integer; The unique identifier of the sponsor.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • BurdenScheduleId; integer; The unique identifier of the burden schedule.
  • BurdenScheduleName; string; The name of the burden schedule.
  • Comments; string; The comments about the sponsor.
  • CreatedBy; string; Created By
  • CreationDate; string; Creation Date
  • FederalFlag; boolean; Indicates whether the sponsor billing is federal.
  • LastUpdateDate; string; Last Updated By
  • LastUpdatedBy; string; Last Updated Date
  • LetterOfCreditFlag; boolean; Indicates whether the sponsor billing is letter of credit.
  • LetterOfCreditNumber; string; The unique number of the sponsor letter of credit.
  • PartyId; integer; The unique party identifier of the sponsor.
  • PrimaryContactEmail; string; The primary contact email address of the sponsor.
  • PrimaryContactName; string; The primary contact name of the sponsor.
  • PrimaryURL; string; The primary URL of the sponsor.
  • RelatedSponsorAccountId; integer; The unique identifier of the related sponsor account.
  • RelatedSponsorAccountName; string; The name of the related sponsor account.
  • RelatedSponsorAccountNumber; string; The unique number of the related sponsor account.
  • RelatedSponsorId; integer; The unique identifier of the related sponsor.
  • RelatedSponsorName; string; The name of the related sponsor.
  • RelatedSponsorNumber; string; The unique number of the related sponsor.
  • SponsorAccountId; integer; The unique identifier of the sponsor account.
  • SponsorAccountName; string; The name of the sponsor account.
  • SponsorAccountNumber; string; The unique number of the sponsor account.
  • SponsorId; integer; The unique identifier of the sponsor.
  • SponsorName; string; The name of the sponsor.
  • SponsorNumber; string; The unique number of the sponsor.
  • Status; string; The status of the sponsor.
  • StatusCode; string; The status code of the sponsor.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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 : grantsSponsors

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{ "required":[ "count", "hasMore", "limit", "links", "offset" ], "type":"object", "properties":{ "totalResults":{ "type":"integer", "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included." }, "offset":{ "type":"integer", "description":"The offset value used in the current page." }, "count":{ "type":"integer", "description":"The number of resource instances returned in the current range." }, "hasMore":{ "type":"boolean", "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false." }, "limit":{ "type":"integer", "description":"The actual paging size used by the server." }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "items":{ "title":"Items", "type":"array", "description":"The items in the collection.", "items":{ "$ref":"#/components/schemas/grantsSponsors-item-response" } } }, "x-hints":{ "usage":"BusinessObject" } }

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object grantsSponsors-item-response

{ "title":"Items", "type":"array", "description":"The items in the collection.", "items":{ "$ref":"#/components/schemas/grantsSponsors-item-response" } }

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 : grantsSponsors-item-response

Type: object

Show Source

• 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.

{ "type":"object", "properties":{ "CreationDate":{ "type":"string", "description":"Creation Date", "format":"date-time", "nullable":false, "readOnly":true, "x-queryable":true }, "grantsSponsorReferenceTypes":{ "title":"Sponsor Reference Types", "type":"array", "description":"The Grants Sponsor Reference Types resource is used to get sponsor reference types.", "items":{ "$ref":"#/components/schemas/grantsSponsors-grantsSponsorReferenceTypes-item-response" } }, "RelatedSponsorName":{ "maxLength":255, "type":"string", "description":"The name of the related sponsor.", "nullable":true, "x-queryable":true }, "SponsorAccountName":{ "maxLength":255, "type":"string", "description":"The name of the sponsor account.", "nullable":true, "x-queryable":true }, "PrimaryContactEmail":{ "title":"Primary Email", "maxLength":320, "type":"string", "description":"The primary contact email address of the sponsor.", "nullable":true, "readOnly":true, "x-hints":{ "protectionKey":"EmailEO.EmailAddress", "protectionObjectTitle":"Email", "protectionState":"TOKENIZED", "protectionAttributeTitle":"Email" }, "x-queryable":true }, "LetterOfCreditNumber":{ "maxLength":240, "type":"string", "description":"The unique number of the sponsor letter of credit.", "nullable":true, "x-queryable":true }, "StatusCode":{ "title":"Party Status", "maxLength":1, "type":"string", "description":"The status code of the sponsor.", "nullable":false, "readOnly":true, "x-queryable":true }, "RelatedSponsorAccountId":{ "type":"integer", "description":"The unique identifier of the related sponsor account.", "format":"int64", "nullable":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "BurdenScheduleId":{ "type":"integer", "description":"The unique identifier of the burden schedule.", "format":"int64", "nullable":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "SponsorName":{ "title":"Sponsor Name", "maxLength":360, "type":"string", "description":"The name of the sponsor.", "nullable":false, "x-hints":{ "controlType":"choice" }, "x-queryable":true }, "RelatedSponsorAccountName":{ "maxLength":255, "type":"string", "description":"The name of the related sponsor account.", "nullable":true, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "PrimaryContactPhone":{ "title":"Primary Phone", "type":"string", "description":"The primary contact phone number of the sponsor.", "nullable":true, "readOnly":true, "x-queryable":false }, "LastUpdatedBy":{ "maxLength":64, "type":"string", "description":"Last Updated Date", "nullable":false, "readOnly":true, "x-queryable":true }, "Status":{ "title":"Status", "maxLength":80, "type":"string", "description":"The status of the sponsor.", "nullable":false, "readOnly":true, "x-queryable":true }, "PrimaryContactName":{ "title":"Name", "maxLength":360, "type":"string", "description":"The primary contact name of the sponsor.", "nullable":false, "readOnly":true, "x-queryable":true }, "CreatedBy":{ "maxLength":64, "type":"string", "description":"Created By", "nullable":false, "readOnly":true, "x-queryable":true }, "RelatedSponsorId":{ "type":"integer", "description":"The unique identifier of the related sponsor.", "format":"int64", "nullable":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "PrimaryContactAddresss":{ "title":"Primary Address", "type":"string", "description":"The primary contact address of the sponsor.", "nullable":true, "readOnly":true, "x-queryable":false }, "Comments":{ "maxLength":2000, "type":"string", "description":"The comments about the sponsor.", "nullable":true, "x-queryable":true }, "LetterOfCreditFlag":{ "maxLength":1, "type":"boolean", "description":"Indicates whether the sponsor billing is letter of credit.", "nullable":true, "x-queryable":true }, "RelatedSponsorNumber":{ "maxLength":255, "type":"string", "description":"The unique number of the related sponsor.", "nullable":true, "x-queryable":true }, "SponsorId":{ "type":"integer", "description":"The unique identifier of the sponsor.", "format":"int64", "nullable":true, "x-hints":{ "precision":18, "fnd:GLOBALLY_UNIQUE":"true" }, "x-queryable":true }, "GrantsSponsorAccountDetails":{ "title":"Grants Sponsor Account Details", "type":"array", "description":"The Grants Sponsor Account Details resource is used to get the details of the sponsor account.", "items":{ "$ref":"#/components/schemas/grantsSponsors-GrantsSponsorAccountDetails-item-response" } }, "SponsorNumber":{ "title":"Sponsor Number", "maxLength":30, "type":"string", "description":"The unique number of the sponsor.", "nullable":false, "x-hints":{ "controlType":"choice" }, "x-queryable":true }, "PartyId":{ "type":"integer", "description":"The unique party identifier of the sponsor.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 }, "x-queryable":true }, "BurdenScheduleName":{ "title":"Sponsor Burden Schedule", "maxLength":30, "type":"string", "description":"The name of the burden schedule.", "nullable":true, "x-hints":{ "controlType":"choice" }, "x-queryable":true }, "SponsorAccountNumber":{ "maxLength":255, "type":"string", "description":"The unique number of the sponsor account.", "nullable":true, "x-queryable":true }, "RelatedSponsorAccountNumber":{ "maxLength":255, "type":"string", "description":"The unique number of the related sponsor account.", "nullable":true, "x-queryable":true }, "PrimaryURL":{ "title":"Primary URL", "maxLength":2000, "type":"string", "description":"The primary URL of the sponsor.", "nullable":true, "readOnly":true, "x-hints":{ "protectionKey":"WebEO.Url", "protectionState":"TOKENIZED", "protectionAttributeTitle":"URL" }, "x-queryable":true }, "SponsorAccountId":{ "title":"Sponsor Account Number", "type":"integer", "description":"The unique identifier of the sponsor account.", "format":"int64", "nullable":false, "default":0, "x-hints":{ "precision":18 }, "x-queryable":true }, "FederalFlag":{ "maxLength":1, "type":"boolean", "description":"Indicates whether the sponsor billing is federal.", "nullable":true, "x-queryable":true }, "LastUpdateDate":{ "type":"string", "description":"Last Updated By", "format":"date-time", "nullable":false, "readOnly":true, "x-queryable":true } } }

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

• Array of: object grantsSponsors-GrantsSponsorAccountDetails-item-response

{ "title":"Grants Sponsor Account Details", "type":"array", "description":"The Grants Sponsor Account Details resource is used to get the details of the sponsor account.", "items":{ "$ref":"#/components/schemas/grantsSponsors-GrantsSponsorAccountDetails-item-response" } }

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

• Array of: object grantsSponsors-grantsSponsorReferenceTypes-item-response

{ "title":"Sponsor Reference Types", "type":"array", "description":"The Grants Sponsor Reference Types resource is used to get sponsor reference types.", "items":{ "$ref":"#/components/schemas/grantsSponsors-grantsSponsorReferenceTypes-item-response" } }

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 : grantsSponsors-GrantsSponsorAccountDetails-item-response

Type: object

Show Source

• 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.

{ "type":"object", "properties":{ "LastUpdatedBy":{ "maxLength":64, "type":"string", "description":"Last Updated By", "nullable":false, "readOnly":true, "x-queryable":true }, "CreationDate":{ "type":"string", "description":"Creation Date", "format":"date-time", "nullable":false, "readOnly":true, "x-queryable":true }, "RelatedSponsorName":{ "maxLength":255, "type":"string", "description":"The name of the related sponsor.", "nullable":true, "x-queryable":true }, "CreatedBy":{ "maxLength":64, "type":"string", "description":"Created By", "nullable":false, "readOnly":true, "x-queryable":true }, "PrimaryFlag":{ "maxLength":1, "type":"boolean", "description":"Indicates whether the sponsor account is primary.", "nullable":true, "x-queryable":true }, "SponsorAccountDetailsId":{ "type":"integer", "description":"The unique identifier or the sponsor account details.", "format":"int64", "nullable":false, "x-hints":{ "precision":18, "fnd:GLOBALLY_UNIQUE":"true" }, "x-queryable":true }, "RelatedSponsorId":{ "type":"integer", "description":"The unique identifier of the related sponsor.", "format":"int64", "nullable":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "SponsorAccountName":{ "title":"Account Description", "maxLength":240, "type":"string", "description":"The name of the sponsor account.", "nullable":true, "x-hints":{ "controlType":"choice" }, "x-queryable":true }, "Comments":{ "maxLength":2000, "type":"string", "description":"The comment about the sponsor account details.", "nullable":true, "x-queryable":true }, "LetterOfCreditFlag":{ "maxLength":1, "type":"boolean", "description":"Indicates whether the sponsor billing is letter of credit.", "nullable":true, "x-queryable":true }, "LetterOfCreditNumber":{ "maxLength":240, "type":"string", "description":"The unique number of the sponsor letter of credit.", "nullable":true, "x-queryable":true }, "RelatedSponsorNumber":{ "maxLength":255, "type":"string", "description":"The unique number of the related sponsor.", "nullable":true, "x-queryable":true }, "RelatedSponsorAccountId":{ "type":"integer", "description":"The unique identifier of the related sponsor account.", "format":"int64", "nullable":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "SponsorId":{ "type":"integer", "description":"The unique identifier of the sponsor.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 }, "x-queryable":true }, "SponsorName":{ "maxLength":255, "type":"string", "description":"The name of the sponsor.", "nullable":true, "x-queryable":true }, "SponsorNumber":{ "maxLength":255, "type":"string", "description":"The unique number of the sponsor.", "nullable":true, "x-queryable":true }, "SponsorAccountNumber":{ "title":"Account Number", "maxLength":30, "type":"string", "description":"The unique number of the sponsor account.", "nullable":false, "x-hints":{ "controlType":"choice" }, "x-queryable":true }, "RelatedSponsorAccountName":{ "title":"Account Description", "maxLength":240, "type":"string", "description":"The name of the related sponsor account.", "nullable":true, "x-hints":{ "controlType":"choice" }, "x-queryable":true }, "RelatedSponsorAccountNumber":{ "title":"Account Number", "maxLength":30, "type":"string", "description":"The unique number of the related sponsor account.", "nullable":true, "x-hints":{ "controlType":"choice" }, "x-queryable":true }, "SponsorAccountId":{ "type":"integer", "description":"The unique identifier of the sponsor account.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 }, "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":"Last Updated Date", "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." } } }

Nested Schema : grantsSponsors-grantsSponsorReferenceTypes-item-response

Type: object

Show Source

• 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.

{ "type":"object", "properties":{ "LastUpdatedBy":{ "maxLength":64, "type":"string", "description":"Last Updated Date", "nullable":false, "readOnly":true, "x-queryable":true }, "SponsorReferenceType":{ "title":"Type", "maxLength":80, "type":"string", "description":"The type of the sponsor reference, for example, Industry.", "nullable":false, "x-hints":{ "controlType":"choice" }, "x-queryable":true }, "CreationDate":{ "type":"string", "description":"Creation Date", "format":"date-time", "nullable":false, "readOnly":true, "x-queryable":true }, "Description":{ "title":"Description", "maxLength":240, "type":"string", "description":"The description of the sponsor reference type.", "nullable":true, "readOnly":true, "x-queryable":true }, "CreatedBy":{ "maxLength":64, "type":"string", "description":"Created By", "nullable":false, "readOnly":true, "x-queryable":true }, "Comments":{ "title":"Comments", "maxLength":2000, "type":"string", "description":"The comments about the sponsor reference type.", "nullable":true, "x-queryable":true }, "SponsorReferenceValue":{ "title":"Value", "maxLength":300, "type":"string", "description":"The value of the sponsor reference type, for example, State Government or Local Government.", "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":"Last Updated By", "format":"date-time", "nullable":false, "readOnly":true, "x-queryable":true }, "SponsorReferenceId":{ "type":"integer", "description":"The unique identifier of the sponsor reference type.", "format":"int64", "nullable":false, "x-hints":{ "precision":18, "fnd:GLOBALLY_UNIQUE":"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" } }

Back to Top

Examples

The following example shows how to get many sponsors 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

Response Body Example

The following shows an example of the response body in JSON format of all project templates.

{ "items": [ { "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" } ] }, ... ], "count": 25, "hasMore": true, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/grantsSponsors", "name": "grantsSponsors", "kind": "collection" } ] }

Back to Top