Service Directory > v31.2 > Resource_Management > Put_Internal_Catalog
 

Operation: Put_Internal_Catalog

This Web Service operation is for creating or updating an Internal Catalog. Creating a new Internal Catalog would set the Add Only flag to true, followed by the required catalog attributes of Name, Currency, and Internal Service Provider. Updating an existing Internal Catalog would set the Add Only flag to false, include a Reference ID or WID to the existing Catalog, followed by the same three required attributes. If a Catalog has catalog items and Catalog Load is in progress, then only the Catalog Name can be updated.


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

Element containing Internal Catalog reference Internal Catalog data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Internal_Catalog_Reference  Internal_Service_CatalogObject  [0..1]  Reference to an existing Internal Catalog.   
Internal_Catalog_Data  Internal_Catalog_Data  [0..1]  Element containing Internal Catalog data. 
Validation Description
There is already an Internal Catalog with that Name and Internal Provider. Please change the Name or the Internal Provider before proceeding.  There is already an Internal Catalog with that Name and Internal Provider. Please change the Name or the Internal Provider before proceeding. 
 
Validation Description
The Web Service is set to Add Only; but the Internal Catalog already exists.  Create a new Internal Catalog, or change 'Add Only' to 'false' to edit the Internal Catalog. 
The Catalog already has catalog items loaded, only the Catalog Name can be updated.  The Catalog already has catalog items loaded, only the Catalog Name can be updated. 
top
 

Response Element: Put_Internal_Catalog_Response

Wrapper element containing Internal Catalog response data for requested references.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Internal_Catalog_Reference  Internal_Service_CatalogObject  [0..1]  Reference to an existing Internal Catalog.   
top
 

Internal_Service_CatalogObject

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

Internal_Service_CatalogObjectID

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

Internal_Catalog_Data

part of: Put_Internal_Catalog_Request
Element containing Internal Catalog data.
 
Parameter name Type/Value Cardinality Description Validations
Internal_Catalog_Reference_ID  string  [0..1]  Internal Catalog Reference ID.   
Catalog_Name  string  [1..1]  Name of the Internal Catalog.   
Internal_Service_Provider_Reference  Internal_Service_ProviderObject  [1..1]  Reference to the Internal Service Provider.   
Currency_Reference  CurrencyObject  [1..1]  Currency Reference   
Validation Description
There is already an Internal Catalog with that Name and Internal Provider. Please change the Name or the Internal Provider before proceeding.  There is already an Internal Catalog with that Name and Internal Provider. Please change the Name or the Internal Provider before proceeding. 
top
 

Internal_Service_ProviderObject

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

Internal_Service_ProviderObjectID

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

CurrencyObject

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

CurrencyObjectID

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

Internal_Service_CatalogReferenceEnumeration

part of: Internal_Service_CatalogObjectID
Base Type
string
top
 

Internal_Service_ProviderReferenceEnumeration

part of: Internal_Service_ProviderObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top