Service Directory > v31.2 > Financial_Management > Get_Proposal_Grants
 

Operation: Get_Proposal_Grants

Request references to one or more proposal grants.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Get_Proposal_Grants_Request

Contains request reference, criteria, filter and response group for getting Proposal Grant data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Proposal_Grant_Request_References  [0..1]  Get Proposal Grant Request References   
Request_Criteria [Choice]   Proposal_Grant_Request_Criteria  [0..1]  Get Proposal Grant Request Criteria   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Proposal_Grant_Response_Group  [0..1]  Element containing Proposal Grant Response Group   
top
 

Response Element: Get_Proposal_Grants_Response

Element containing Proposal Grant response elements including received criteria, references, data based
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Proposal_Grant_Request_References  [0..1]  Element containing reference instances for Proposal Grants   
Request_Criteria  Proposal_Grant_Request_Criteria  [0..1]  Element containing Proposal Grant request criteria   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Proposal_Grant_Response_Group  [0..1]  Element containing Proposal Grant Response Group   
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Proposal_Grant_Response_Data  [0..1]  Wrapper Element that includes Proposal Grant Instance and Data   
top
 

Proposal_Grant_Request_References

part of: Get_Proposal_Grants_Request, Get_Proposal_Grants_Response
Element containing reference instances for Proposal Grants
 
Parameter name Type/Value Cardinality Description Validations
Proposal_Grant_Reference  Proposal_GrantObject  [1..*]  This is the reference ID value of the Proposal Grant instance   
top
 

Proposal_GrantObject

part of: Proposal_Grant_Request_References, Proposal_Grant
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Proposal_GrantObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Proposal_GrantObjectID

part of: Proposal_GrantObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Proposal_Grant_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Proposal_Grant_Request_Criteria

part of: Get_Proposal_Grants_Request, Get_Proposal_Grants_Response
Element containing Proposal Grant request criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Proposal_Grants_Request, Get_Proposal_Grants_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Proposal_Grant_Response_Group

part of: Get_Proposal_Grants_Request, Get_Proposal_Grants_Response
Element containing Proposal Grant Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Proposal_Grants_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Proposal_Grant_Response_Data

part of: Get_Proposal_Grants_Response
Wrapper Element that includes Proposal Grant Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Proposal_Grant  Proposal_Grant  [0..*]  Wrapper Element that includes Proposal Grant Instance and Data   
top
 

Proposal_Grant

part of: Proposal_Grant_Response_Data
Wrapper Element that includes Proposal Grant Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Proposal_Grant_Reference  Proposal_GrantObject  [0..1]  This is the reference ID value of the Proposal Grant instance   
Proposal_Grant_Data  Proposal_Grant_Data  [0..*]  Element containing Proposal Grant Data 
Validation Description
Proposal Grant name is already in use.   
 
top
 

Proposal_Grant_Data

part of: Proposal_Grant
Element containing Proposal Grant data
 
Parameter name Type/Value Cardinality Description Validations
Proposal_Grant_Reference_ID  string  [0..1]  ID. This is the Proposal Grant unique identifier   
Proposal_Grant_Name  string  [1..1]  Unique name of a Proposal Grant   
Validation Description
Proposal Grant name is already in use.   
top
 

Proposal_GrantReferenceEnumeration

part of: Proposal_GrantObjectID
Base Type
string
top