Service Directory > v31.2 > Resource_Management > Put_Supplier_Catalog
 

Operation: Put_Supplier_Catalog

This Web Service operation can be used to create or update a Supplier Catalog. To create a new Supplier Catalog set Add Only to true and provide the Catalog Name, Currency, and Supplier. To update an existing Supplier Catalog set Add Only to false and include a Reference ID or WID to the existing Catalog. Note that you may not modify the Currency or Supplier for a Supplier Catalog that is in use by one or more Supplier Contracts.


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

Element to capture Supplier 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.   
Supplier_Catalog_Reference  Supplier_CatalogObject  [0..1]  Reference to an existing Supplier Catalog.   
Supplier_Catalog_Data  Supplier_Catalog_Data  [0..1]  Element containing Supplier Catalog data. 
Validation Description
There is already a Catalog with that Name and Supplier. Please change the Name or the Supplier before proceeding.  There is already a Catalog with that Name and Supplier. Please change the Name or the Supplier before proceeding. 
This Supplier Catalog is currently in use by one or more Supplier Contracts. You may not modify the Currency or Supplier for a Supplier Catalog that is in use.  This Supplier Catalog is currently in use by one or more Supplier Contracts. You may not modify the Currency or Supplier for a Supplier Catalog that is in use. 
 
Validation Description
The Web Service is set to Add Only; but the Supplier Catalog already exists.  Create a new Supplier Catalog, or change 'Add Only' to 'false' to edit the Supplier Catalog. 
top
 

Response Element: Put_Supplier_Catalog_Response

Element containing Supplier Catalog response data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Supplier_Catalog_Reference  Supplier_CatalogObject  [0..1]  Reference to an existing Supplier Catalog.   
top
 

Supplier_CatalogObject

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

Supplier_CatalogObjectID

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

Supplier_Catalog_Data

part of: Put_Supplier_Catalog_Request
Element containing Supplier Catalog data.
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Catalog_Reference_ID  string  [0..1]  Supplier Catalog Reference ID. This is the Supplier Catalog unique identifier.   
Catalog_Name  string  [1..1]  Supplier Catalog Name.   
Supplier_Reference  Resource_ProviderObject  [1..1]  Reference to an existing Supplier. Note that this cannot be an Internal Service Provider. 
Validation Description
The Supplier Reference provided is not valid for Supplier Catalogs.   
 
Currency_Reference  CurrencyObject  [1..1]  Currency Reference   
Validation Description
There is already a Catalog with that Name and Supplier. Please change the Name or the Supplier before proceeding.  There is already a Catalog with that Name and Supplier. Please change the Name or the Supplier before proceeding. 
This Supplier Catalog is currently in use by one or more Supplier Contracts. You may not modify the Currency or Supplier for a Supplier Catalog that is in use.  This Supplier Catalog is currently in use by one or more Supplier Contracts. You may not modify the Currency or Supplier for a Supplier Catalog that is in use. 
top
 

Resource_ProviderObject

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

Resource_ProviderObjectID

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

Supplier_CatalogReferenceEnumeration

part of: Supplier_CatalogObjectID
Base Type
string
top
 

Resource_ProviderReferenceEnumeration

part of: Resource_ProviderObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top