Service Directory > v31.2 > Human_Resources > Get_Supervisory_Organization_Assignment_Restrictions
 

Operation: Get_Supervisory_Organization_Assignment_Restrictions

This operation retrieves the Organization Assignment Default Values and Allowed Values for Supervisory Organizations.


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

Get Organization Assignment Restrictions Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Organization_Assignment_Restrictions_Request_References  [0..1]  Organization Assignment Restrictions Request 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_Organization_Assignment_Restrictions_Response

Get Organization Assignment Restrictions Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Organization_Assignment_Restrictions_Request_References  [0..1]  Organization Assignment Restrictions Request 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. 
 
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  Organization_Assignment_Restrictions_Response_Data  [0..1]  Response Data   
top
 

Organization_Assignment_Restrictions_Request_References

part of: Get_Organization_Assignment_Restrictions_Request, Get_Organization_Assignment_Restrictions_Response
Organization Assignment Restrictions Request References
 
Parameter name Type/Value Cardinality Description Validations
Supervisory_Organization_Reference  Supervisory_OrganizationObject  [1..*]  Supervisory Organization Reference   
top
 

Supervisory_OrganizationObject

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

Supervisory_OrganizationObjectID

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

Response_Filter

part of: Get_Organization_Assignment_Restrictions_Request, Get_Organization_Assignment_Restrictions_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_Organization_Assignment_Restrictions_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
 

Organization_Assignment_Restrictions_Response_Data

part of: Get_Organization_Assignment_Restrictions_Response
Response Data
 
Parameter name Type/Value Cardinality Description Validations
Organization_Assignment_Restrictions  Organization_Assignment_Restrictions  [0..*]  Organization Assignment Restrictions Response Data   
top
 

Organization_Assignment_Restrictions

part of: Organization_Assignment_Restrictions_Response_Data
Organization Assignment Restrictions Response Data
 
Parameter name Type/Value Cardinality Description Validations
Organization_Assignment_Restrictions_Data  Organization_Assignment_Restrictions_Data  [0..1]  Organization Assignment Restrictions Data 
Validation Description
An Organization Type only allows 1 Default Organization Assignment.  An Organization Type only allows 1 Default Organization Assignment. 
Organization Types in request can not duplicate.  Organization Types in request can not duplicate. 
Default Cost Center [cost_center] has 'Restricted To Companies' and the default value for Company [company] must be one of them. If Company has allowed values, then they must include one of the 'Restricted To Companies' as the default value for Company must also be an allowed value.  Default Company must be one of the 'Restricted To Companies' for default Cost Center. 
 
top
 

Organization_Assignment_Restrictions_Data

part of: Organization_Assignment_Restrictions
Organization Assignment Restrictions Data
 
Parameter name Type/Value Cardinality Description Validations
@Replace_All  boolean  [1..1]  Default to FALSE, if omitted. If set to TRUE, all existing Allowed/Default Organization(s) will be removed before any further processes. If inheritance of default and allowed values from the superior is being severed, setting this to 'TRUE' will not persist inherited values for any org type.   
Supervisory_Organization_Reference  Supervisory_OrganizationObject  [1..1]  Supervisory Organization Reference holds the Superviosry Organization for which the allowed/default organization(s) will be changed.   
Organization_Assignment_Restrictions_by_Type_Data  Organization_Assignment_Restrictions_by_Type_Data  [0..*]  Organization Assignment Restrictions Data for an Organization Type 
Validation Description
Organization Assignment Restrictions or Defaults cannot be specified for this organization type ([org type]).  Organization Assignment Restrictions or Defaults cannot be specified for this organization type. 
Because allowed organization is defined for the organization type, default organization must be one of the allowed organizations.   
Select only 1 default organization when the Position Assignment Unique report field is true.   
 
Validation Description
An Organization Type only allows 1 Default Organization Assignment.  An Organization Type only allows 1 Default Organization Assignment. 
Organization Types in request can not duplicate.  Organization Types in request can not duplicate. 
Default Cost Center [cost_center] has 'Restricted To Companies' and the default value for Company [company] must be one of them. If Company has allowed values, then they must include one of the 'Restricted To Companies' as the default value for Company must also be an allowed value.  Default Company must be one of the 'Restricted To Companies' for default Cost Center. 
top
 

Organization_Assignment_Restrictions_by_Type_Data

part of: Organization_Assignment_Restrictions_Data
Organization Assignment Restrictions by Type Data
 
Parameter name Type/Value Cardinality Description Validations
Organization_Type_Reference  Organization_TypeObject  [1..1]  Organization Type Reference. Can not be duplicated within 1 request.   
Allowed_Organization_Data  Staff_Allowed_Data  [0..*]  Allowed Organization Data   
Default_Organization_Data  Staff_Default_Data  [0..*]  Default Organization Data   
Validation Description
Organization Assignment Restrictions or Defaults cannot be specified for this organization type ([org type]).  Organization Assignment Restrictions or Defaults cannot be specified for this organization type. 
Because allowed organization is defined for the organization type, default organization must be one of the allowed organizations.   
Select only 1 default organization when the Position Assignment Unique report field is true.   
top
 

Organization_TypeObject

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

Organization_TypeObjectID

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

Staff_Allowed_Data

part of: Organization_Assignment_Restrictions_by_Type_Data
Allowed Organization Data
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  Boolean to indicate if existing default value is to be deleted. The existing default value must be correctly specified. Do not set to true (or 'y' in EIB) to replace the existing default value.   
Allowed_Organization_Reference  StaffObject  [1..*]  Allowed Organization References   
top
 

StaffObject

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

StaffObjectID

part of: StaffObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Business_Unit_ID, Company_Reference_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Fund_ID, Gift_Reference_ID, Grant_ID, Organization_Reference_ID, Program_ID, Region_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
 

Staff_Default_Data

part of: Organization_Assignment_Restrictions_by_Type_Data
Default Organization Data
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  When set to TRUE, the values in Default_Organization_Reference will be removed from existing Default Organization; when omitted or set to FALSE, the values in Default_Organization_Reference will be merged into existing Default Organization. If inheritance of default and allowed values from the superior is being severed, setting this to 'TRUE' will not persist inherited values for this org type.   
Default_Organization_Reference  StaffObject  [0..1]  Default Organization Reference   
top
 

Supervisory_OrganizationReferenceEnumeration

part of: Supervisory_OrganizationObjectID
Base Type
string
top
 

Organization_TypeReferenceEnumeration

part of: Organization_TypeObjectID
Base Type
string
top
 

StaffReferenceEnumeration

part of: StaffObjectID
Base Type
string
top