Service Directory > v31.2 > Staffing > Get_Probation_Period_Outcomes
 

Operation: Get_Probation_Period_Outcomes

Get the Probation Period Outcomes for one or more countries.


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

Request element for Get Probation Period Outcomes
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Probation_Period_Outcomes_For_Country_Request_References  [0..1]  Request element for Probation Period Outcome References   
Request_Criteria  Probation_Period_Outcomes_For_Country_Request_Criteria  [0..1]  Request element for Country References   
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_Probation_Period_Outcomes_Response

Response containing all Probation Period Outcomes which met the Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Probation_Period_Outcomes_For_Country_Request_References  [0..1]  Request element for Probation Period Outcome References   
Request_Criteria  Probation_Period_Outcomes_For_Country_Request_Criteria  [0..1]  Request element for Country References   
Response_Data  Probation_Period_Outcomes_For_Country_Response_Data  [0..1]  Probation Period Outcomes For Country Response Data Element   
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.   
top
 

Probation_Period_Outcomes_For_Country_Request_References

part of: Get_Probation_Period_Outcomes_Response, Get_Probation_Period_Outcomes_Request
Request element for Probation Period Outcome References
 
Parameter name Type/Value Cardinality Description Validations
Probation_Period_Outcomes_For_Country_Reference  Probation_Period_Outcomes_Setup_TableObject  [1..*]  Probation Period Outcome References   
top
 

Probation_Period_Outcomes_Setup_TableObject

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

Probation_Period_Outcomes_Setup_TableObjectID

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

Probation_Period_Outcomes_For_Country_Request_Criteria

part of: Get_Probation_Period_Outcomes_Response, Get_Probation_Period_Outcomes_Request
Request element for Country References
 
Parameter name Type/Value Cardinality Description Validations
Country_Reference  CountryObject  [0..*]  Country Reference   
top
 

CountryObject

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

CountryObjectID

part of: CountryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code  [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_Probation_Period_Outcomes_Response, Get_Probation_Period_Outcomes_Request
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
 

Probation_Period_Outcomes_For_Country_Response_Data

part of: Get_Probation_Period_Outcomes_Response
Probation Period Outcomes For Country Response Data Element
 
Parameter name Type/Value Cardinality Description Validations
Probation_Period_Outcomes  Probation_Period_Outcome_Response_Data  [0..*]  Response Data element for Get Probation Period Outcomes web service.   
top
 

Probation_Period_Outcome_Response_Data

part of: Probation_Period_Outcomes_For_Country_Response_Data
Response Data element for Get Probation Period Outcomes web service.
 
Parameter name Type/Value Cardinality Description Validations
Probation_Period_Outcomes_For_Country_Reference  Probation_Period_Outcomes_Setup_TableObject  [0..1]  Probation Period Outcome for Country Reference   
Probation_Period_Outcomes_Data  Probation_Period_Outcomes_For_Country_Data  [0..*]  Data element containing Probation Period Outcomes and Country Reference. 
Validation Description
You must include all probation period outcome references for all probation period outcomes that are in use for [country].   
You can't edit probation period outcomes that are not configured as probation period outcomes for [country].   
 
top
 

Probation_Period_Outcomes_For_Country_Data

part of: Probation_Period_Outcome_Response_Data
Data element containing Probation Period Outcomes and Country Reference.
 
Parameter name Type/Value Cardinality Description Validations
Country_Reference  CountryObject  [1..1]  Country reference   
Probation_Period_Outcome_Data  Probation_Period_Outcome_Data  [0..*]  Probation Period Outcome Data   
Validation Description
You must include all probation period outcome references for all probation period outcomes that are in use for [country].   
You can't edit probation period outcomes that are not configured as probation period outcomes for [country].   
top
 

Probation_Period_Outcome_Data

part of: Probation_Period_Outcomes_For_Country_Data
Adds a probation period outcome row.
 
Parameter name Type/Value Cardinality Description Validations
Probation_Period_Outcome_Reference  Probation_Period_OutcomeObject  [0..1]  Probation Period Outcome Reference   
Probation_Period_Outcome_Name  string  [1..1]  Probation Period Outcome Name   
Probation_Period_Actions_Reference  Probation_Period_ActionObject  [1..*]  Probation Period Actions Reference   
Inactive  boolean  [0..1]  Inactive   
top
 

Probation_Period_OutcomeObject

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

Probation_Period_OutcomeObjectID

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

Probation_Period_ActionObject

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

Probation_Period_ActionObjectID

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

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

Probation_Period_Outcomes_Setup_TableReferenceEnumeration

part of: Probation_Period_Outcomes_Setup_TableObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Probation_Period_OutcomeReferenceEnumeration

part of: Probation_Period_OutcomeObjectID
Base Type
string
top
 

Probation_Period_ActionReferenceEnumeration

part of: Probation_Period_ActionObjectID
Base Type
string
top