Service Directory > v32.1 > Performance_Management > Put_Organization_Goal
 

Operation: Put_Organization_Goal

This operation allows adding a new or editing an existing ~Goal~ 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: Put_Organization_Goal_Request

Web Service Element for Put Organization Goal Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only boolean that signifies the Organization Goal will be added   
Organization_Goal_Reference  Organization_GoalObject  [0..1]  Web Service Element for Put Organization Goal Request   
Organization_Goal_Data  Organization_Goal_Data  [1..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.   
 
Validation Description
Organization Goal already exists.   
top
 

Response Element: Put_Organization_Goal_Response

Web service Element that returns the Organization Goal Reference and Exceptions Response Data after a Put request is sent
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Organization_Goal_Reference  Organization_GoalObject  [0..1]  References the Organization Goal class   
Exceptions_Response_Data  Application_Instance_Related_Exceptions_Data  [0..*]  Element that returns Exceptions Data related to the Organization Goal   
top
 

Organization_GoalObject

part of: Organization_Goal_Data, Put_Organization_Goal_Request, Put_Organization_Goal_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  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_Data

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

Supervisory_OrganizationObject

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  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_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
 

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
 

Application_Instance_Related_Exceptions_Data

part of: Put_Organization_Goal_Response
Element containing Exceptions Data
 
Parameter name Type/Value Cardinality Description Validations
Exceptions_Data  Application_Instance_Exceptions_Data  [0..*]  Exceptions Data   
top
 

Application_Instance_Exceptions_Data

part of: Application_Instance_Related_Exceptions_Data
Element containing application related exceptions data
 
Parameter name Type/Value Cardinality Description Validations
Exception_Data  Exception_Data  [0..*]  Exception Data   
top
 

Exception_Data

part of: Application_Instance_Exceptions_Data
Exception (Errors and Warning) associated with the transaction.
 
Parameter name Type/Value Cardinality Description Validations
Classification  string  [0..1]  Exception Classification (Error or Warning)   
Message  string  [0..1]  Exception Detail   
top
 

Organization_GoalReferenceEnumeration

part of: Organization_GoalObjectID
Base Type
string
top
 

RichText

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

InitiativeReferenceEnumeration

part of: InitiativeObjectID
Base Type
string
top