Service Directory > v25.1 > Resource_Management > Get_Catalog_Items
 

Operation: Get_Catalog_Items

This service operation will get Catalog Items for the specified criteria. Catalog Item Data includes Catalog Item Reference, Item Identifier, Item Name, Item Description, current Unit Price, Unit of Measure Reference, Spend Category Reference, Item URL, Supplier Order Contract Reference, Is Catalog Load Active, and Catalog Item Data Data. Catalog Item Data Data includes Catalog Item Data Effective Date, Unit Price and Catalog Item Data isActive. The request criteria can be for a single Catalog Item based on Reference, Catalog Items based on search criteria (Such as Item Identifier and/or one of the following: Supplier Order Contract, Resource Provider and Company or Company Hierarchy), or all Catalog Items if no criteria is specified. There is no corresponding Put Catalog Item web service task as this is accomplished through the Catalog Load Request.


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

Get Catalog Items Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Catalog_Item_Request_References  [0..1]  Contains request reference, criteria, filter and response group for getting Catalog Item data   
Request_Criteria [Choice]   Catalog_Item_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Catalog_Items_Response

Get Catalog Items Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Catalog_Item_Request_References  [0..1]  Catalog Item Reference   
Request_Criteria  Catalog_Item_Request_Criteria  [0..1]  Catalog Item Request Criteria   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Catalog_Item_Response_Data  [0..1]  Get Catalog Items Response   
top
 

Catalog_Item_Request_References

part of: Get_Catalog_Items_Request, Get_Catalog_Items_Response
Catalog Item Request References
 
Parameter name Type/Value Cardinality Description Validations
Catalog_Item_Reference  Catalog_ItemObject  [1..*]  Catalog Item Reference   
top
 

Catalog_ItemObject

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

Catalog_ItemObjectID

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

Catalog_Item_Request_Criteria

part of: Get_Catalog_Items_Request, Get_Catalog_Items_Response
Catalog Item Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Catalog_Item_Identifier  string  [0..1]  Catalog Item Identifier   
Catalog_Item_Supplier_Order_Contract_Reference [Choice]   Supplier_ContractObject  [0..1]  Supplier Order Contract for Catalog Items   
Company_or_Company_Hierarchy_for_Supplier_Order_Contract_Reference [Choice]   OrganizationObject  [0..1]  Company or Company Hierarchy for Supplier Order Contracts for Catalog Items   
Resource_Provider_for_Supplier_Order_Contract_Reference [Choice]   Resource_ProviderObject  [0..*]  Resource Provider for Supplier Order Contracts for Catalog Items   
Supplier_Catalogs_for_Catalog_Items_Reference  Supplier_CatalogObject  [0..*]  Supplier Catalogs for Catalog Items   
top
 

Supplier_ContractObject

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

Supplier_ContractObjectID

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

OrganizationObject

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

OrganizationObjectID

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

Resource_ProviderObject

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

Supplier_CatalogObject

part of: Catalog_Item_Request_Criteria, Catalog_Item_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  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
 

Response_Filter

part of: Get_Catalog_Items_Request, Get_Catalog_Items_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_Catalog_Items_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Catalog_Item_Response_Data

part of: Get_Catalog_Items_Response
Catalog Item Response Data
 
Parameter name Type/Value Cardinality Description Validations
Catalog_Item  Catalog_Item  [0..*]  Catalog Item Response Data   
top
 

Catalog_Item

part of: Catalog_Item_Response_Data
Catalog Item Response Data
 
Parameter name Type/Value Cardinality Description Validations
Catalog_Item_Reference  Catalog_ItemObject  [0..1]  The ID of the Catalog Item   
Catalog_Item_Data  Catalog_Item_Data  [0..*]  Catalog Item Data   
top
 

Catalog_Item_Data

part of: Catalog_Item
Catalog Item Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The ID of the Catalog Item   
Item_Identifier  string  [0..1]  Catalog Item Identifier   
Item_Name  string  [0..1]  Catalog Item Name   
Item_Description  string  [0..1]  Catalog Item Description   
Catalog_Item_current_Unit_Price  decimal (26, 6)   [0..1]  Catalog Item Unit Price   
Unit_of_Measure_Reference  Unit_of_MeasureObject  [0..1]  Catalog Item Unit of Measure Code Reference   
Spend_Category_Reference  Spend_CategoryObject  [0..1]  Catalog Item Spend Category   
Supplier_Catalog_Reference  Supplier_CatalogObject  [0..1]  Supplier Catalog for Catalog Item   
Item_URL  string  [0..1]  Catalog Item URL   
Supplier_Order_Contract_Reference  Supplier_ContractObject  [0..1]  Supplier Order Contract for Catalog Item   
Is_Catalog_Item_currently_Active  boolean  [0..1]  Is the Catalog Item currently Active   
Catalog_Item_Data_Data  Catalog_Item_Data_Data  [0..*]  Catalog Item Data Data   
top
 

Unit_of_MeasureObject

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

Unit_of_MeasureObjectID

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

Spend_CategoryObject

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

Spend_CategoryObjectID

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

Catalog_Item_Data_Data

part of: Catalog_Item_Data
Catalog Item Data Data
 
Parameter name Type/Value Cardinality Description Validations
Catalog_Item_Data_Effective_Date  date  [0..1]  Effective date of the Catalog Item Data used for pricing.   
Unit_Price  decimal (26, 6)   [0..1]  Price of Catalog Item starting on the Effective Date.   
Catalog_Item_Data_isActive  boolean  [0..1]  Is Catalog Item Data pricing active?   
top
 

Catalog_ItemReferenceEnumeration

part of: Catalog_ItemObjectID
Base Type
string
top
 

Supplier_ContractReferenceEnumeration

part of: Supplier_ContractObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Resource_ProviderReferenceEnumeration

part of: Resource_ProviderObjectID
Base Type
string
top
 

Supplier_CatalogReferenceEnumeration

part of: Supplier_CatalogObjectID
Base Type
string
top
 

Unit_of_MeasureReferenceEnumeration

part of: Unit_of_MeasureObjectID
Base Type
string
top
 

Spend_CategoryReferenceEnumeration

part of: Spend_CategoryObjectID
Base Type
string
top