Service Directory > v31.2 > Adoption > Put_Adoption_Item
 

Operation: Put_Adoption_Item

This operation adds an Adoption Item.


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

Element container for Put Adoption Item request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  The Add Only flag indicates that the service is an add only, not an update. Always set this flag to true for Put Adoption Item web service.   
Adoption_Item_Data  Adoption_Item_Data  [1..1]  Element container for all Adoption Item data.   
Validation Description
This web service does not support editing. Add Only flag must be set to true.   
top
 

Response Element: Put_Adoption_Item_Response

Element Container for Put Adoption Item response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Adoption_Item_Reference  Adoption_ItemObject  [0..1]  Adoption Item instance.   
top
 

Adoption_Item_Data

part of: Put_Adoption_Item_Request
Element container for all Adoption Item data.
 
Parameter name Type/Value Cardinality Description Validations
Adoption_Item_Field_Data  Adoption_Item_Fields_Data  [0..1]  Element Container for basic Adoption Item data. 
Validation Description
Planned End Date is required when Adoption Item status is Roadmap.   
Planned Start Date is required when Adoption Item status is Roadmap.   
You can’t have duplicate adoption items. To proceed, change the value of at least one of these fields: Name, Type, Status, Planned Start Date, or Planned End Date.   
 
Adoption_Item_Priority_Data  Priority_Evaluation_Fields_Data  [0..1]  Element container for Priority Evaluation Data of Adoption Item.   
Adoption_Item_Roadmap_Data  Adoption_Item_Roadmap_Fields_Data  [0..1]  Element container for Roadmap Data of Adoption Item. 
Validation Description
Planned Start Date must be less than or equal to Planned End Date.   
 
Adoption_Item_Notes_and_Attachments_Data  Adoption_Notes_and_Attachments_Data  [0..1]  Element container for Notes and Attachments Data of Adoption Item.   
top
 

Adoption_Item_Fields_Data

part of: Adoption_Item_Data
Element Container for basic Adoption Item data.
 
Parameter name Type/Value Cardinality Description Validations
Adoption_Item_Name  string  [1..1]  Name of the Adoption Item.   
Adoption_Item_Order  string (6)   [0..1]  Order of the Adoption Item.   
Adoption_Item_Description  string  [0..1]  Description of the Adoption Item.   
Adoption_Item_Assigned_To_Reference  WorkerObject  [0..*]  Worker assigned to Adoption Item. 
Validation Description
Adoption Item Assigned To is required when Adoption Item Status is Roadmap.   
 
Adoption_Item_Type_Reference  Adoption_Item_Type__All_Object  [1..1]  Type of the Adoption Item.   
Adoption_Item_Status_Reference  Adoption_Item_Status__All_Object  [1..1]  Status of the Adoption Item.   
Adoption_Item_Functional_Area_Reference  Functional_AreaObject  [0..*]  Functional Areas of the Adoption Item.   
Adoption_Item_Domain_Reference  Unique_IdentifierObject  [0..*]  Domains of the Adoption Item. Must be part of Functional Areas selected. 
Validation Description
At least one selected Domain is not associated with the selected Functional Area(s).   
 
Adoption_Item_Inactive  boolean  [0..1]  Indicates if Adoption Item is inactive. 
Validation Description
Do not mark the adoption item as Inactive if the status is in the roadmap state.   
 
Adoption_Item_Requested_By_Reference  WorkerObject  [0..1]  Worker that requested the Adoption Item.   
Adoption_Item_Custom_Date_1  date  [0..1]  Custom Date 1 of the Adoption Item.   
Adoption_Item_Custom_Date_2  date  [0..1]  Custom Date 2 of the Adoption Item.   
Validation Description
Planned End Date is required when Adoption Item status is Roadmap.   
Planned Start Date is required when Adoption Item status is Roadmap.   
You can’t have duplicate adoption items. To proceed, change the value of at least one of these fields: Name, Type, Status, Planned Start Date, or Planned End Date.   
top
 

WorkerObject

part of: Adoption_Item_Fields_Data, Adoption_Item_Fields_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
 

Adoption_Item_Type__All_Object

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

Adoption_Item_Type__All_ObjectID

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

Adoption_Item_Status__All_Object

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

Adoption_Item_Status__All_ObjectID

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

Functional_AreaObject

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

Functional_AreaObjectID

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

Priority_Evaluation_Fields_Data

part of: Adoption_Item_Data
Element container for Priority Evaluation Data of Adoption Item.
 
Parameter name Type/Value Cardinality Description Validations
Adoption_Item_Priority_Reference  Adoption_Item_Priority__All_Object  [0..1]  Priority of the Adoption Item.   
Adoption_Item_Urgency_Reference  Adoption_Item_Urgency__All_Object  [0..1]  Urgency of the Adoption Item.   
Adoption_Item_Value_Reference  Adoption_Item_Value__All_Object  [0..1]  Value of the Adoption Item.   
Adoption_Item_Setup_Effort_Reference  Setup_EffortObject  [0..1]  Setup Effort of the Adoption Item   
Adoption_Item_Work_Effort_Reference  Adoption_Item_Work_Effort__All_Object  [0..1]  Work Effort of the Adoption Item.   
Adoption_Item_Business_Risk_Reference  Adoption_Item_Business_Risk__All_Object  [0..1]  Business Risk of the Adoption Item.   
Adoption_Item_Impact  string  [0..1]  Impact of the Adoption Item.   
top
 

Adoption_Item_Priority__All_Object

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

Adoption_Item_Priority__All_ObjectID

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

Adoption_Item_Urgency__All_Object

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

Adoption_Item_Urgency__All_ObjectID

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

Adoption_Item_Value__All_Object

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

Adoption_Item_Value__All_ObjectID

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

Setup_EffortObject

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

Setup_EffortObjectID

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

Adoption_Item_Work_Effort__All_Object

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

Adoption_Item_Work_Effort__All_ObjectID

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

Adoption_Item_Business_Risk__All_Object

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

Adoption_Item_Business_Risk__All_ObjectID

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

Adoption_Item_Roadmap_Fields_Data

part of: Adoption_Item_Data
Element container for Roadmap Data of Adoption Item.
 
Parameter name Type/Value Cardinality Description Validations
Adoption_Item_Planned_Start_Date  date  [0..1]  Planned Start Date of the Adoption Item.   
Adoption_Item_Planned_End_Date  date  [0..1]  Planned End Date of the Adoption Item.   
Adoption_Item_Customer_Release_Reference  Adoption_Customer_ReleaseObject  [0..1]  Customer Release that the Adoption Item belongs to.   
Adoption_Item_Tied_to_Workday_Release_Reference  Workday_ReleaseObject  [0..1]  Workday Release that the Adoption Item is tied to. 
Validation Description
Change the Customer Release of the Adoption Item. This Customer Release is inactive and cannot be attached to an Adoption Item with a Status of In Backlog, In Review, Prioritized, or On Roadmap.   
 
Validation Description
Planned Start Date must be less than or equal to Planned End Date.   
top
 

Adoption_Customer_ReleaseObject

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

Adoption_Customer_ReleaseObjectID

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

Workday_ReleaseObject

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

Workday_ReleaseObjectID

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

Adoption_Notes_and_Attachments_Data

part of: Adoption_Item_Data
Element container for Notes and Attachments Data of Adoption Item.
 
Parameter name Type/Value Cardinality Description Validations
Adoption_Item_Reason  string  [0..1]  Reason for the Adoption Item.   
What_s_New_Item_Reference  Unique_IdentifierObject  [0..*]  What's New Item linked to Adoption Item.   
Adoption_Item_URLs_Reference  External_URLObject  [0..*]  External URLs linked to the Adoption Item.   
Adoption_Item_Notes  RichText  [0..1]  Note about the Adoption Item.   
Adoption_Item_Attachment  Adoption_Attachment_Data  [0..*]  Element container for Attachment data of the Adoption Item.   
top
 

External_URLObject

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

External_URLObjectID

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

Adoption_Attachment_Data

part of: Adoption_Notes_and_Attachments_Data
Element container for Adoption Item attachment.
 
Parameter name Type/Value Cardinality Description Validations
Adoption_Item_Attachment_Reference  Adoption_Item_AttachmentObject  [0..1]  Reference for Adoption Item attachment.   
Adoption_Item_Attachment_Data  Attachment_WWS_Data  [0..1]  Element container for Adoption Item attachment data.   
top
 

Adoption_Item_AttachmentObject

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

Adoption_Item_AttachmentObjectID

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

Attachment_WWS_Data

part of: Adoption_Attachment_Data
Attachment WWS Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Text attribute identifying a unique ID for Attachment.   
Filename  string (255)   [1..1]  Filename for the attachment.   
File_Content  base64Binary  [1..1]  File content in binary format.   
Mime_Type_Reference  Mime_TypeObject  [0..1]  Mime Type Reference   
Comment  string  [0..1]  Comment   
top
 

Mime_TypeObject

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

Mime_TypeObjectID

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

Adoption_ItemObject

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

Adoption_ItemObjectID

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Adoption_Item_Type__All_ReferenceEnumeration

part of: Adoption_Item_Type__All_ObjectID
Base Type
string
top
 

Adoption_Item_Status__All_ReferenceEnumeration

part of: Adoption_Item_Status__All_ObjectID
Base Type
string
top
 

Functional_AreaReferenceEnumeration

part of: Functional_AreaObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Adoption_Item_Priority__All_ReferenceEnumeration

part of: Adoption_Item_Priority__All_ObjectID
Base Type
string
top
 

Adoption_Item_Urgency__All_ReferenceEnumeration

part of: Adoption_Item_Urgency__All_ObjectID
Base Type
string
top
 

Adoption_Item_Value__All_ReferenceEnumeration

part of: Adoption_Item_Value__All_ObjectID
Base Type
string
top
 

Setup_EffortReferenceEnumeration

part of: Setup_EffortObjectID
Base Type
string
top
 

Adoption_Item_Work_Effort__All_ReferenceEnumeration

part of: Adoption_Item_Work_Effort__All_ObjectID
Base Type
string
top
 

Adoption_Item_Business_Risk__All_ReferenceEnumeration

part of: Adoption_Item_Business_Risk__All_ObjectID
Base Type
string
top
 

Adoption_Customer_ReleaseReferenceEnumeration

part of: Adoption_Customer_ReleaseObjectID
Base Type
string
top
 

Workday_ReleaseReferenceEnumeration

part of: Workday_ReleaseObjectID
Base Type
string
top
 

External_URLReferenceEnumeration

part of: External_URLObjectID
Base Type
string
top
 

RichText

part of: Adoption_Notes_and_Attachments_Data
Base Type
string
top
 

Adoption_Item_AttachmentReferenceEnumeration

part of: Adoption_Item_AttachmentObjectID
Base Type
string
top
 

Mime_TypeReferenceEnumeration

part of: Mime_TypeObjectID
Base Type
string
top
 

Adoption_ItemReferenceEnumeration

part of: Adoption_ItemObjectID
Base Type
string
top