Service Directory > v31.2 > Performance_Management > Get_Organization_Goals
 

Operation: Get_Organization_Goals

This operation allows getting existing ~Goals~ for an Organization.


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

Web Service Element for Get Organization Goals Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Organization_Goal_Request_References  [0..1]  Web Service Element for Get Organization Goals Request   
Request_Criteria [Choice]   Organization_Goal_Request_Criteria  [0..1]  Web Service Element for Get Organization Goals Request   
Response_Filter  Response_Filter  [0..1]  Web Service Element for Get Organization Goals Request 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Organization_Goal_Response_Group  [0..1]  Web Service Element for Get Organization Goals Request   
top
 

Response Element: Get_Organization_Goals_Response

Web Service Element for Get Organization Goals Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Organization_Goal_Request_References  [0..1]  Web Service Element for Get Organization Goals Response   
Request_Criteria  Organization_Goal_Request_Criteria  [0..1]  Web Service Element for Get Organization Goals Response   
Response_Filter  Response_Filter  [0..1]  Web Service Element for Get Organization Goals Response 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Organization_Goal_Response_Group  [0..1]  Web Service Element for Get Organization Goals Response   
Response_Results  Response_Results  [0..1]  Web Service Element for Get Organization Goals Response   
Response_Data  Organization_Goal_Response_Data  [0..1]  Element for Organization Goal Response Data   
top
 

Organization_Goal_Request_References

part of: Get_Organization_Goals_Request, Get_Organization_Goals_Response
Element for Organization Goal Request References
 
Parameter name Type/Value Cardinality Description Validations
Organization_Goal_Reference  Organization_GoalObject  [1..*]  Element for Organization Goal Request References   
top
 

Organization_GoalObject

part of: Organization_Goal_Request_References, Organization_Goal, Organization_Goal_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_GoalObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Organization_GoalObjectID

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

part of: Get_Organization_Goals_Request, Get_Organization_Goals_Response
Element which contains the Supervisory Org and Goal Plan Period references that define the Organization Goal Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Supervisory_Organization_Reference  Supervisory_OrganizationObject  [0..1]  Element which contains the Supervisory Org and Goal Plan Period references that define the Organization Goal Request Criteria   
Goal_Plan_Period_Reference  Goal_Plan_Period_DefinitionObject  [0..1]  Element which contains the Supervisory Org and Goal Plan Period references that define the Organization Goal Request Criteria   
top
 

Supervisory_OrganizationObject

part of: Organization_Goal_Request_Criteria, Organization_Goal_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
 

Goal_Plan_Period_DefinitionObject

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

Goal_Plan_Period_DefinitionObjectID

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

part of: Get_Organization_Goals_Request, Get_Organization_Goals_Response
Element that defines whether the Organization Goal Response Group includes references or not
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Element that defines whether the Organization Goal Response Group includes references or not   
top
 

Response_Results

part of: Get_Organization_Goals_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_Goal_Response_Data

part of: Get_Organization_Goals_Response
Element for Organization Goal Response Data
 
Parameter name Type/Value Cardinality Description Validations
Organization_Goal  Organization_Goal  [0..*]  The Organization Goal that contains the Organization Goal Reference and Data object   
top
 

Organization_Goal

part of: Organization_Goal_Response_Data
Element for Organization Goal
 
Parameter name Type/Value Cardinality Description Validations
Organization_Goal_Reference  Organization_GoalObject  [0..1]  Element for Organization Goal   
Organization_Goal_Data  Organization_Goal_Data  [0..1]  Element which contains all the components that define an Organization Goal. 
Validation Description
An Organization Goal cannot be private and have supporting Initiatives. Please either remove the Initiatives or remove the private flag.   
 
top
 

Organization_Goal_Data

part of: Organization_Goal
Element which contains all the components that define an Organization Goal.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The ID of an Organization Goal   
Name  string  [1..1]  The name of an Organization Goal   
Description  RichText  [0..1]  The description for this Organization Goal   
Percent_Complete  decimal (7, 4) >0   [0..1]  To what percent this Organization Goal is completed   
Supervisory_Organization_Reference  Supervisory_OrganizationObject  [1..1]  The Organization this Organization Goal belongs to   
Goal_Plan_Period_Definition_Reference  Goal_Plan_Period_DefinitionObject  [1..1]  The Goal Period for this Organization Goal   
Organization_Goal_Superior_Reference  Organization_GoalObject  [0..1]  References a superior Organization's Goal that this Organization supports   
Initiative_Reference  InitiativeObject  [0..*]  References Initiatives that are supported by the Organization this Organization Goal is for 
Validation Description
The following Initiatives are already attached to an Organization Goal that is not the current one: [initiatives]   
 
Private  boolean  [0..1]  Private boolean that signifies whether this Organization Goal can only be seen by members in this Organization chain or not   
Validation Description
An Organization Goal cannot be private and have supporting Initiatives. Please either remove the Initiatives or remove the private flag.   
top
 

InitiativeObject

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

InitiativeObjectID

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

part of: Organization_GoalObjectID
Base Type
string
top
 

Supervisory_OrganizationReferenceEnumeration

part of: Supervisory_OrganizationObjectID
Base Type
string
top
 

Goal_Plan_Period_DefinitionReferenceEnumeration

part of: Goal_Plan_Period_DefinitionObjectID
Base Type
string
top
 

RichText

part of: Organization_Goal_Data
Base Type
string
top
 

InitiativeReferenceEnumeration

part of: InitiativeObjectID
Base Type
string
top