Service Directory > v31.2 > Performance_Management > Get_Fields_Of_Study
 

Operation: Get_Fields_Of_Study

This operation will get the Field of Studies currently defined.


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

Request element for the Get Fields Of Study operation
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Field_Of_Study_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Field of Study and its associated data.   
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. 
 
top
 

Response Element: Get_Fields_Of_Study_Response

Response element for the Get Fields Of Study operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Field_Of_Study_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Field of Study and its associated data.   
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_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  Field_Of_Study_Response_Data  [0..1]  Response element for the Get Fields Of Study operation.   
top
 

Field_Of_Study_Request_References

part of: Get_Fields_Of_Study_Request, Get_Fields_Of_Study_Response
Utilize the Request References element to retrieve a specific instance(s) of Field of Study and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
Field_Of_Study_Reference  Field_of_StudyObject  [1..*]  A unique identifier used to reference a Field Of Study.   
top
 

Field_of_StudyObject

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

Field_of_StudyObjectID

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

Response_Filter

part of: Get_Fields_Of_Study_Request, Get_Fields_Of_Study_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
 

Response_Results

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

Field_Of_Study_Response_Data

part of: Get_Fields_Of_Study_Response
Response element for the Get Fields Of Study operation.
 
Parameter name Type/Value Cardinality Description Validations
Field_Of_Study  Field_Of_Study  [0..*]  Encapsulating element containing all Field of Study data.   
top
 

Field_Of_Study

part of: Field_Of_Study_Response_Data
Encapsulating element containing all Field of Study data.
 
Parameter name Type/Value Cardinality Description Validations
Field_Of_Study_Reference  Field_of_StudyObject  [0..1]  A unique identifier used to reference a Field Of Study.   
Field_Of_Study_Data  Field_Of_Study_Data  [0..1]  Contains the detailed information about a Field of Study.   
top
 

Field_Of_Study_Data

part of: Field_Of_Study
Contains the detailed information about a Field of Study.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID field (Field_Of_Study_ID)   
Name  string  [0..1]  The name of the Field of Study (this is required for add and non-blank on update) 
Validation Description
Name is required.   
 
CIP_Code_Reference  CIP_Code__Workday_Owned_Object  [0..1]  Provides a reference to the CIP code for this field of study.   
Inactive  boolean  [0..1]  Indicates if the field of study is inactive. If a field of study is inactive, it will no longer be allowed to be selected when a worker adds an education.   
top
 

CIP_Code__Workday_Owned_Object

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

CIP_Code__Workday_Owned_ObjectID

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

Field_of_StudyReferenceEnumeration

part of: Field_of_StudyObjectID
Base Type
string
top
 

CIP_Code__Workday_Owned_ReferenceEnumeration

part of: CIP_Code__Workday_Owned_ObjectID
Base Type
string
top