Service Directory > v31.2 > Revenue_Management > Get_Subawards
 

Operation: Get_Subawards

This service operation will get Subawards for the specified requested references. If none are specified, all Subawards are returned. Subaward data includes Subaward Reference, Award Contract Reference, Award Contract Line Reference, Subrecipient Reference, Location Reference, Subject to FFATA Reference, Attachment Data, and Subaward Contact Data.


@ - 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_Subawards_Request

Element containing request references, criteria, filter and response group for getting Subaward.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Reference [Choice]   Subaward_Request_References  [0..1]  Element containing references to Subaward.   
Request_Criteria [Choice]   Subaward_Request_Criteria  [0..1]  Element containing request criteria for finding Subawards.   
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  Subaward_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Subaward response. If this element is not included then ALL of the Response Groups are included in the response.   
top
 

Response Element: Get_Subawards_Response

Element containing Subaward response elements including echoed request data and request result data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Subaward_Request_References  [0..1]  Element containing references to Subaward.   
Request_Criteria  Subaward_Request_Criteria  [0..1]  Element containing request criteria for finding Subawards.   
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  Subaward_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Subaward response. If this element is not included then ALL of the Response Groups are included in the response.   
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  Subaward_Response_Data  [0..1]  Wrapper element containing Subaward Response Data for requested references or criteria.   
top
 

Subaward_Request_References

part of: Get_Subawards_Request, Get_Subawards_Response
Element containing references to Subaward.
 
Parameter name Type/Value Cardinality Description Validations
Subaward_Reference  Subaward_AbstractObject  [1..*]  Subaward requested for the Get operation.   
top
 

Subaward_AbstractObject

part of: Subaward_Request_References, Subaward
 
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  Subaward_AbstractObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Subaward_AbstractObjectID

part of: Subaward_AbstractObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Supplier_Contract_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
 

Subaward_Request_Criteria

part of: Get_Subawards_Request, Get_Subawards_Response
Element containing request criteria for finding Subawards.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Subawards_Request, Get_Subawards_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
 

Subaward_Response_Group

part of: Get_Subawards_Request, Get_Subawards_Response
Wrapper element around a list of elements representing the amount of data that should be included in the Subaward response. If this element is not included then ALL of the Response Groups are included in the response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include a reference to the Subaward.   
Include_Subaward_Data  boolean  [0..1]  Flag indicating if the Subaward Reference data is to be included in the response.   
Include_Attachment_Data  boolean  [0..1]  Flag indicating if Subaward Attachment Data should be included in the response.   
Include_Contact_Data  boolean  [0..1]  Flag indicating if Subaward Contact Data should be included in the response.   
top
 

Response_Results

part of: Get_Subawards_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
 

Subaward_Response_Data

part of: Get_Subawards_Response
Wrapper element containing Subaward Response Data for requested references or criteria.
 
Parameter name Type/Value Cardinality Description Validations
Subaward  Subaward  [0..*]  Subaward element.   
top
 

Subaward

part of: Subaward_Response_Data
Wrapper element that includes all data for a single Subaward.
 
Parameter name Type/Value Cardinality Description Validations
Subaward_Reference  Subaward_AbstractObject  [0..1]  Reference to a single Subaward for which data is being returned.   
Subaward_Data  Subaward_Data  [0..1]  Element containing Grants related data for a single Subaward. 
Validation Description
Award Line entered does not have a Subrecipient.   
Subrecipient for Award Line does not match Subrecipient entered.   
Subrecipient for Subaward does not match Subrecipient entered.   
The grant on the supplier contract must match the grant on the award line.   
Award Line entered already has a different Subaward associated to it. Enter an Award Line that does not have a Subaward.   
Award Line entered does not match the Award Contract entered.   
You must enter Yes in the Subject to FFATA field if you enter an FFATA Amount.   
 
top
 

Subaward_Data

part of: Subaward
Element containing Grants related data for a single Subaward.
 
Parameter name Type/Value Cardinality Description Validations
Subaward_ID  string  [0..1]  Subaward Reference ID. This is the Subaward unique identifier.   
Award_Contract_Reference  Award_ContractObject  [0..1]  The Award Contract Reference related to the Subaward.   
Award_Contract_Line_Reference  Award_Contract_LineObject  [1..1]  Award Contract Line Reference related to the Subaward.   
Subrecipient_Reference  Subrecipient_AbstractObject  [0..1]  The Subrecipient Reference related to the Subaward.   
Location_Reference  LocationObject  [0..*]  The Location Reference related to the Subaward.   
Subject_to_FFATA_Reference  Subject_to_FFATAObject  [0..1]  The Subaward is subject to FFATA Reference related to the Subaward.   
FFATA_Amount  decimal (17, 2) >0   [0..1]  The amount subject to FFATA.   
Attachment_Data  Financials_Attachment_Data  [0..*]  Attachment Data 
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
 
Subaward_Contact_Data  Subaward_Business_Entity_Contact_Data  [0..*]  The Subaward Contact Data related to the Subaward. 
Validation Description
Business Entity Contact Type Usage is not Subaward.   
Business Entity Contact entered is already in use on another Subaward.   
Contact Type marked as Inactive cannot be added to the subaward.   
 
Validation Description
Award Line entered does not have a Subrecipient.   
Subrecipient for Award Line does not match Subrecipient entered.   
Subrecipient for Subaward does not match Subrecipient entered.   
The grant on the supplier contract must match the grant on the award line.   
Award Line entered already has a different Subaward associated to it. Enter an Award Line that does not have a Subaward.   
Award Line entered does not match the Award Contract entered.   
You must enter Yes in the Subject to FFATA field if you enter an FFATA Amount.   
top
 

Award_ContractObject

part of: Subaward_Data
 
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  Award_ContractObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Award_ContractObjectID

part of: Award_ContractObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Award_Reference_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
 

Award_Contract_LineObject

part of: Subaward_Data
 
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  Award_Contract_LineObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Award_Contract_LineObjectID

part of: Award_Contract_LineObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Receivable_Contract_Line_Reference_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
 

Subrecipient_AbstractObject

part of: Subaward_Data
 
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  Subrecipient_AbstractObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Subrecipient_AbstractObjectID

part of: Subrecipient_AbstractObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Supplier_ID, Supplier_Reference_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
 

LocationObject

part of: Subaward_Data
 
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  LocationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

LocationObjectID

part of: LocationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Location_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
 

Subject_to_FFATAObject

part of: Subaward_Data
 
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  Subject_to_FFATAObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Subject_to_FFATAObjectID

part of: Subject_to_FFATAObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Subject_to_FFATA_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
 

Financials_Attachment_Data

part of: Subaward_Data
Encapsulating element containing all Business Document Attachment data.
 
Parameter name Type/Value Cardinality Description Validations
@Content_Type  string (80)   [1..1]  Text attribute identifying Content Type of the Attachment.   
@Filename  string (255)   [1..1]  Text attribute identifying Filename of the Attachment.   
@Encoding  string  [1..1]  Text attribute identifying Encoding of the Attachment.   
@Compressed  boolean  [1..1]  Boolean attribute identifying whether the Attachment is compressed.   
File_Content  base64Binary  [0..1]  File content in binary format.   
Comment  string  [0..1]  Comment   
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
top
 

Subaward_Business_Entity_Contact_Data

part of: Subaward_Data
Element containing Business Entity Contact Data with Contact Type specific to Subawards.
 
Parameter name Type/Value Cardinality Description Validations
Contact_Type_Reference  Business_Entity_Contact_Type_TenantedObject  [0..1]  The Business Entity Contact Type Tenanted Reference related to Subaward Business Entity Contact Type Usage.   
Subaward_Business_Entity_Contact_Reference  Business_Entity_ContactObject  [0..1]  Business Entity Contact Data   
Validation Description
Business Entity Contact Type Usage is not Subaward.   
Business Entity Contact entered is already in use on another Subaward.   
Contact Type marked as Inactive cannot be added to the subaward.   
top
 

Business_Entity_Contact_Type_TenantedObject

part of: Subaward_Business_Entity_Contact_Data
 
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  Business_Entity_Contact_Type_TenantedObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Business_Entity_Contact_Type_TenantedObjectID

part of: Business_Entity_Contact_Type_TenantedObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Business_Entity_Contact_Type_Tenanted_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
 

Business_Entity_ContactObject

part of: Subaward_Business_Entity_Contact_Data
 
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  Business_Entity_ContactObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Business_Entity_ContactObjectID

part of: Business_Entity_ContactObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Business_Entity_Contact_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
 

Subaward_AbstractReferenceEnumeration

part of: Subaward_AbstractObjectID
Base Type
string
top
 

Award_ContractReferenceEnumeration

part of: Award_ContractObjectID
Base Type
string
top
 

Award_Contract_LineReferenceEnumeration

part of: Award_Contract_LineObjectID
Base Type
string
top
 

Subrecipient_AbstractReferenceEnumeration

part of: Subrecipient_AbstractObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Subject_to_FFATAReferenceEnumeration

part of: Subject_to_FFATAObjectID
Base Type
string
top
 

Business_Entity_Contact_Type_TenantedReferenceEnumeration

part of: Business_Entity_Contact_Type_TenantedObjectID
Base Type
string
top
 

Business_Entity_ContactReferenceEnumeration

part of: Business_Entity_ContactObjectID
Base Type
string
top