Service Directory > v32.1 > Human_Resources > Get_Organizations_Names
 

Operation: Get_Organizations_Names

Retrieves data related to the organization name or names in effect for a specified date range. If both From and To dates are empty, Workday retrieves data related to the organization name as of the current date. Retrieves all organizations unless Organization or Organization Type is specified.


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

Contains request reference, criteria, filter and response group for getting Organization Names
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Organization_Name_Request_References  [0..1]  Organization Name Request References   
Request_Criteria [Choice]   Organization_Name_Request_Criteria  [0..1]  Organization Name 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  Organization_Name_Response_Group  [0..1]  Organization Name Response Group   
top
 

Response Element: Get_Organizations_Names_Response

Contains request reference, criteria, filter and response group, response results, and organization name response data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Organization_Name_Request_References  [0..1]  Organization Name Request References   
Request_Criteria  Organization_Name_Request_Criteria  [0..1]  Organization Name 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  Organization_Name_Response_Group  [0..1]  Organization Name Response Group   
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Organization_Name_Response_Data  [0..1]  Organization Name Response Data   
top
 

Organization_Name_Request_References

part of: Get_Organizations_Names_Request, Get_Organizations_Names_Response
Wrapper for Request References
 
Parameter name Type/Value Cardinality Description Validations
Organization_Reference  OrganizationObject  [1..*]  References to specific Organizations   
Organization_Name_in_Effect_From  date  [0..1]  The starting date of a date range. If Org Name In Effect From and Org Name In Effect To are empty, Workday retrieves the organization name as of the current date. If Org Name In Effect From and Org Name In Effect To are filled, Workday retrieves the organization name effective within the date range. If Org Name In Effect From is filled and Org Name In Effect To is empty, Workday retrieves all organization names since Org Name In Effect From date. If Org Name In Effect From is empty and Org Name In Effect To is filled, Workday retrieves all organization names up to Org Name In Effect To date. A new effective-dated organization name is automatically created if any attributes used for organization name are different as of specified effective date which include: Organization Name, Organization Code, and Include 'xx' in Name booleans.   
Organization_Name_in_Effect_To  date  [0..1]  The end date of a date range. Refer to field description for "Org Name In Effect From" for how these two dates work together.   
top
 

OrganizationObject

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

OrganizationObjectID

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

Organization_Name_Request_Criteria

part of: Get_Organizations_Names_Request, Get_Organizations_Names_Response
Wrapper for Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Organization_Name_in_Effect_From  date  [0..1]  The start date of a date range. If Org Name In Effect From and Org Name In Effect To are both empty, organization name as of the current date is retrieved. If both dates are filled, all the organization names in effect within the date range are retrieved. If From date is filled and To date is empty, all organization names in effect as of and including the From date are retrieved. If From date is empty and To date is filled, all organization names in effect up to and including the To date are retrieved.   
Organization_Name_in_Effect_To  date  [0..1]  The end date of a date range. Refer to field description for "Org Name In Effect From" for how these two dates work together.   
Organization_Type_Reference  Organization_TypeObject  [0..*]  This element allows you to filter the organizations retrieved by type. This is an optional parameter. Ignored if an organization is specified.   
Include_Inactive  boolean  [0..1]  Set this attribute to true to include Inactive Organizations in your results. Default is to not include. This is an optional parameter. Ignored if an organization is specified.   
top
 

Organization_TypeObject

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

Response_Filter

part of: Get_Organizations_Names_Request, Get_Organizations_Names_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
 

Organization_Name_Response_Group

part of: Get_Organizations_Names_Request, Get_Organizations_Names_Response
Wrapper for Response Group
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Results

part of: Get_Organizations_Names_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_Name_Response_Data

part of: Get_Organizations_Names_Response
Wrapper for Organization Name information
 
Parameter name Type/Value Cardinality Description Validations
Organization_Name  Organization_Name  [0..*]  Organization Name   
top
 

Organization_Name

part of: Organization_Name_Response_Data
Wrapper for Organization Name Data
 
Parameter name Type/Value Cardinality Description Validations
Organization_Reference  OrganizationObject  [0..1]  Organization Reference   
Organization_Name_Data  Organization_Name_Data  [0..*]  Organization Name Data 
Validation Description
Organization Code is required If 'Include Organization Code in Name' is selected.  Organization Code is required If 'Include Organization Code in Name' is selected. 
 
top
 

Organization_Name_Data

part of: Organization_Name
Contains information for Organization name data
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [0..1]  Effective Date   
Organization_ID  string  [0..1]  Integration Reference ID used for integration purposes; This is also the Organization ID   
Organization_Name  string  [0..1]  Text attribute identifying Organization Name. 
Validation Description
Enter an Organization Name or use the Organization Code as the name by entering an Organization Code and selecting the 'Include Organization Code in Name' checkbox.   
Enter an Organization Name or select the 'Include Manager/Leader in Name' checkbox or use the Organization Code as the name by entering an Organization Code and selecting the 'Include Organization Code in Name' checkbox.   
 
Phonetic_Name  string  [0..1]  Phonetic Name 
Validation Description
You can only submit for Phonetic Name for Companies   
You can't submit this field(Phonetic Name) until you first select both the Enabled and Workday-Supported checkboxes for your preferred language(Japanese, Korean, Chinese) in the Languages Section on the Edit Tenant Setup - Global task. You must also specify your preferred language in the "Enable Languages of Phonetic Name for Company" field.   
 
Include_Organization_ID_in_Name  boolean  [0..1]  Boolean attribute identifying whether to include the Organization ID within the name (Display ID within Workday). 
Validation Description
'Include Organization ID in Name' can only be set to true for supervisory organizations.   
 
Organization_Code  string  [0..1]  Text attribute identifying Organization Code.   
Include_Organization_Code_in_Name  boolean  [0..1]  Boolean attribute identifying whether to include the Organization Code within the name (Display ID within Workday).   
Include_Manager_Leader_in_Name  boolean  [0..1]  Boolean attribute identifying whether to include the Manager/Leader Name within the name (Display ID in Workday). 
Validation Description
Include Manager/Leader in Name is not valid for an organization of this organization type.   
 
Validation Description
Organization Code is required If 'Include Organization Code in Name' is selected.  Organization Code is required If 'Include Organization Code in Name' is selected. 
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Organization_TypeReferenceEnumeration

part of: Organization_TypeObjectID
Base Type
string
top