Service Directory > v23.0 > Performance_Management > Manage_Goals
 

Operation: Manage_Goals

This operation allows adding a new worker goal and editing an existing goal for a worker.


@ - 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: Manage_Goals_Request

Contains the Manage Goal web service Request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Submit Add Only when you don't want to use the Goal Reference ID to update an existing Goal but still want to create a Goal Reference ID. This provides a performance improvement when loading many goals. When submitting Add Only for this web service, Workday will not prevent you from submitting duplicate Goals.   
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place.   
Manage_Goals_Data  Manage_Goals_Data  [1..1]  Contains the Worker and Goal Details element that contains their new Goal.   
top
 

Response Element: Manage_Goals_Response

Response Element for Manage Goal.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Worker_Goal_Event_Reference  Unique_IdentifierObject  [0..1]  Reference to an instance of Worker Goal Event.   
Worker_Goal_Detail_Reference  Unique_IdentifierObject  [0..*]  Reference to an instance of Worker Goal Detail.   
top
 

Business_Process_Parameters

part of: Manage_Goals_Request
Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place.
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Run_Now  boolean  [0..1]  Indicates the transaction should process to completion before the response is generated. Note: All < v12 operations will process with Run_Now = True for backwards compatibility but please review this setting in your environment for performance conditions.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
top
 

Business_Process_Comment_Data

part of: Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

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

WorkerObjectID

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

Manage_Goals_Data

part of: Manage_Goals_Request
Contains the Worker and Goal Details element that contains their new Goal.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  Contains the instance of the Worker for whom the new goal will be created.   
Worker_Goal_Detail_Data  Worker_Goal_Detail_Data  [0..*]  Wrapper Element for Goal Detail information. 
Validation Description
A goal must have a name.   
 
top
 

Worker_Goal_Detail_Data

part of: Manage_Goals_Data
Wrapper Element for Goal Detail information.
 
Parameter name Type/Value Cardinality Description Validations
Goal_Reference  GoalObject  [0..1]  The Goal reference for this goal detail.   
Goal_Reference_ID  string  [0..1]  When you are creating a new goal, you can leave this Goal Reference ID attribute blank and an external reference ID will be automatically generated. If you are creating a new Worker Goal Detail snapshot for an existing Goal, you must pass in the Reference ID to that Goal in this attribute. If you are creating a new goal from an external system, you can set the Goal Reference ID to the goal id from the external system and it will be saved on the new goal.   
Name  RichText  [0..1]  The Goal Name is required since it is the primary identification for the Goal.   
Description  RichText  [0..1]  The optional long description of the Goal.   
Goal_Category_Reference  Goal_CategoryObject  [0..*]  The optional set of Goal Categories for this Goal. The Reference ID can be set with the type Goal_Category_ID.   
Organization_Goal_Reference  Organization_GoalObject  [0..1]  Contains an Organization Goal that this Worker Goal supports. The Reference ID can be set with the type Organization_Goal_ID.   
Goal_Weight  decimal (14, 2) >0   [0..1]  The numeric weight of the Goal relative to other Goals.   
Due_Date  date  [0..1]  The date the Goal is due to be completed.   
Status_Reference  Component_CompletionObject  [0..1]  The optional Completion Status you can use to indicate if the Goal is, for example, In Process or Completed. The Reference ID can be set using the type Component_Completion_ID.   
Completion_Date  date  [0..1]  The date the Goal was actually completed.   
Note  RichText  [0..1]  The optional Note that you can add to a Goal. The Note is created separate from the Worker Goal Event business process and will not be removed if the business process is recinded.   
Worker_Goal_Milestone_Detail_Data  Worker_Goal_Milestone_Detail_Data  [0..*]  Wrapper Element for Goal Milestone Detail information. 
Validation Description
Goal Milestones not enabled.   
 
Validation Description
A goal must have a name.   
top
 

GoalObject

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

GoalObjectID

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

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

Goal_CategoryObjectID

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

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

Component_CompletionObject

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

Component_CompletionObjectID

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

Worker_Goal_Milestone_Detail_Data

part of: Worker_Goal_Detail_Data
Wrapper Element for Goal Milestone Detail information.
 
Parameter name Type/Value Cardinality Description Validations
Goal_Milestone_Reference  Goal_MilestoneObject  [0..1]  Goal Milestone Reference for this Goal Milestone Detail.   
Goal_Milestone_Reference_ID  string  [0..1]  When creating a new Goal Milestone, leave the Goal Milestone Reference ID attribute blank and an external reference ID will be automatically generated. If you are creating a new Worker Goal Milestone Detail snapshot for an existing Goal Milestone, you must pass in the Reference ID for the Goal Milestone.   
Goal_Milestone_Name  string  [1..1]  The Goal Milestone Name is required to create a new Goal Milestone.   
Goal_Milestone_Due_Date  date  [0..1]  The date the Goal Milestone is due to be completed.   
Goal_Milestone_Status_Reference  Component_CompletionObject  [0..1]  The Completion Status of the Goal Milestone. The Reference ID can be set using the type Component_Completion_ID.   
Validation Description
Goal Milestones not enabled.   
top
 

Goal_MilestoneObject

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

Goal_MilestoneObjectID

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

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

GoalReferenceEnumeration

part of: GoalObjectID
Base Type
string
top
 

RichText

part of: Worker_Goal_Detail_Data, Worker_Goal_Detail_Data, Worker_Goal_Detail_Data
Base Type
string
top
 

Goal_CategoryReferenceEnumeration

part of: Goal_CategoryObjectID
Base Type
string
top
 

Organization_GoalReferenceEnumeration

part of: Organization_GoalObjectID
Base Type
string
top
 

Component_CompletionReferenceEnumeration

part of: Component_CompletionObjectID
Base Type
string
top
 

Goal_MilestoneReferenceEnumeration

part of: Goal_MilestoneObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top