Service Directory > v32.1 > Resource_Management > Get_Internal_Catalogs
 

Operation: Get_Internal_Catalogs

This Web Service operation is for retrieving Internal Catalogs by References or by Criteria. Either References or Criteria must be provided, but not both at the same time. References can be specified by one or more Reference ID or WID. Criteria can be specified by the attributes catalog Name, Currency, and Internal Service Provider. If using Criteria, at least one criterion attribute must be provided. The Response Data will include the following catalog attributes: Name, Internal Service Provider, Currency, and Catalog Data if available. The Catalog Data contains Catalog Item Data loaded for the catalog. Each Catalog Item Data has the following attributes: Currently Active, Current Rate, Unit of Measure, Spend Category, Item Description, Lead Time, Item URL, Purchase Item, and the Pricing History.


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

Element containing sub elements for Request Reference, Request Criteria, Response Filter and Response Group for getting Internal Catalog data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Internal_Catalog_Request_References  [0..1]  Element containing sub elements for Request Reference, Request Criteria, Response Filter and Response Group for getting Internal Catalog data.   
Request_Criteria [Choice]   Internal_Catalog_Request_Criteria  [0..1]  Element containing the filter criteria for Internal Catalogs. 
Validation Description
At least one selection criteria must be entered.   
 
Response_Filter  Response_Filter  [0..1]  Wrapper element containing filtering criteria to subset the Internal Catalogs to return in the response. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Internal_Catalog_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the response.   
Validation Description
At least one selection criteria must be entered.   
top
 

Response Element: Get_Internal_Catalogs_Response

Element containing Internal Catalog response elements including request data and request result data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Internal_Catalog_Request_References  [0..*]  Element containing the instances of Internal Catalog.   
Request_Criteria  Internal_Catalog_Request_Criteria  [0..*]  Element containing the criteria for retrieving Internal Catalogs. 
Validation Description
At least one selection criteria must be entered.   
 
Response_Filter  Response_Filter  [0..*]  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_Group  Internal_Catalog_Response_Group  [0..*]  Element containing the Internal Catalog Response Group.   
Response_Results  Response_Results  [0..*]  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  Internal_Catalog_Response_Data  [0..*]  Element containing Internal Catalog data.   
top
 

Internal_Catalog_Request_References

part of: Get_Internal_Catalogs_Request, Get_Internal_Catalogs_Response
"References" element allowing the specification of specific object instances to be returned based on ID values.
 
Parameter name Type/Value Cardinality Description Validations
Internal_Catalog_Reference  Internal_Service_CatalogObject  [1..*]  Reference to existing Internal Service Catalogs   
top
 

Internal_Service_CatalogObject

part of: Internal_Catalog_Request_References, Internal_Catalog
 
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_Request_Criteria

part of: Get_Internal_Catalogs_Request, Get_Internal_Catalogs_Response
Element containing the criteria for retrieving Internal Catalogs.
 
Parameter name Type/Value Cardinality Description Validations
Catalog_Name  string  [0..1]  Name of the Internal Catalog.   
Currency_Reference  CurrencyObject  [0..1]  Currency Reference   
Internal_Service_Provider_Reference  Internal_Service_ProviderObject  [0..1]  Reference to the Internal Service Provider.   
Validation Description
At least one selection criteria must be entered.   
top
 

CurrencyObject

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

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

Response_Filter

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

Internal_Catalog_Response_Group

part of: Get_Internal_Catalogs_Request, Get_Internal_Catalogs_Response
Include Reference flag
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Internal_Catalog_Response_Data

part of: Get_Internal_Catalogs_Response
Wrapper element containing Internal Catalog response data for requested references.
 
Parameter name Type/Value Cardinality Description Validations
Internal_Catalog  Internal_Catalog  [0..*]  Wrapper element for Internal Catalog Reference and Internal Catalog Data.   
top
 

Internal_Catalog

part of: Internal_Catalog_Response_Data
Wrapper element for Internal Catalog Reference and Internal Catalog Data.
 
Parameter name Type/Value Cardinality Description Validations
Internal_Catalog_Reference  Internal_Service_CatalogObject  [0..1]  Reference to an existing Internal Catalog.   
Internal_Catalog_Data  Internal_Catalog_Data  [0..*]  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. 
 
Catalog_Item_Data  Catalog_Item_for_Internal_Catalog_Data  [0..*]  Catalog Item Data   
top
 

Internal_Catalog_Data

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

Catalog_Item_for_Internal_Catalog_Data

part of: Internal_Catalog
Element containing Internal Catalog data.
 
Parameter name Type/Value Cardinality Description Validations
Catalog_Item_Reference  Catalog_ItemObject  [0..1]  Catalog Item Reference   
Item_Identifier  string  [1..1]  Internal Catalog Reference ID.   
Currently_Active  boolean  [0..1]  Is the Catalog Item currently Active   
Current_Default_Rate  decimal (26, 6)   [0..1]  The current rate of the default ordering unit of measure for the internal service catalog item.   
Default_Ordering_Unit_of_Measure_Reference  Unit_of_MeasureObject  [1..1]  The default ordering unit of measure for the catalog item.   
Base_Unit_of_Measure_Reference  Unit_of_MeasureObject  [0..1]  Base Unit of Measure Reference   
Spend_Category_Reference  Spend_CategoryObject  [1..1]  Reference to the Spend Category.   
Item_Description  string  [1..1]  Item Description   
Lead_Time  decimal (12, 0) >0   [0..1]  Catalog Item Lead Time   
Item_URL  string  [0..1]  Catalog Item URL   
Purchase_Item_Reference  Purchase_ItemObject  [0..1]  Purchase Item Reference   
Primary_Image_Data  Primary_Image_Data  [0..1]  Primary Image for Item   
Additional_Image_Data  Additional_Image_Data  [0..*]  Additional Image for Item   
UOM_Pricing_History  Catalog_Item_Data_for_Catalog_Data  [0..*]  Catalog Item Data   
top
 

Catalog_ItemObject

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

Unit_of_MeasureObject

part of: Catalog_Item_Data_for_Catalog_Data, Catalog_Item_for_Internal_Catalog_Data, Catalog_Item_for_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  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, UOM_EDI_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_for_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  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
 

Purchase_ItemObject

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

Purchase_ItemObjectID

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

Primary_Image_Data

part of: Catalog_Item_for_Internal_Catalog_Data
Primary Image for Item
 
Parameter name Type/Value Cardinality Description Validations
Image_Reference  ImageObject  [0..1]  Image reference if it is an existing image   
Image_Data  Image_Data  [0..1]  Image Data associated with Image   
top
 

ImageObject

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

ImageObjectID

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

Image_Data

part of: Primary_Image_Data, Additional_Image_Data
Image Data
 
Parameter name Type/Value Cardinality Description Validations
Filename  string (255)   [1..1]  Filename of Image   
File  base64Binary  [0..1]  File associated with Image   
top
 

Additional_Image_Data

part of: Catalog_Item_for_Internal_Catalog_Data
Additional Image for Item
 
Parameter name Type/Value Cardinality Description Validations
Image_Reference  ImageObject  [0..1]  Image reference if it is an existing image   
Image_Data  Image_Data  [0..1]  Image Data associated with Image   
top
 

Catalog_Item_Data_for_Catalog_Data

part of: Catalog_Item_for_Internal_Catalog_Data
Catalog Item Data
 
Parameter name Type/Value Cardinality Description Validations
Catalog_Item_Data_Reference  Unique_IdentifierObject  [0..1]  Catalog Item Data   
Effective_Date  date  [1..1]  Effective as of Date   
Unit_Price_as_of_Effective_Date  decimal (26, 6)   [0..1]  Catalog Item Unit Price   
Unit_of_Measure_Reference  Unit_of_MeasureObject  [0..1]  Unit of Measure Reference for the catalog item pricing history.   
Conversion_Factor  decimal (21, 9) >0   [0..1]  Conversion Factor for the ordering unit of measure to the base unit of measure of the catalog item.   
Default_Unit_of_Measure  boolean  [0..1]  Indicates whether this Unit of Measure is the default UOM.   
Just_In_Time  boolean  [0..1]  Indicates whether the Unit Of Measure is applicable for Just In Time.   
Lead_Time  decimal (12, 0) >0   [0..1]  Lead time for the UOM of the Catalog Item.   
Minimum_Order_Quantity  decimal (22, 2) >0   [0..1]  The Minimum Order Quantity for a given UOM for the Catalog Item Pricing History.   
Inactive  boolean  [0..1]  Indicates whether the unit of measure and pricing history is Inactive.   
top
 

Unique_IdentifierObject

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

Internal_Service_CatalogReferenceEnumeration

part of: Internal_Service_CatalogObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Internal_Service_ProviderReferenceEnumeration

part of: Internal_Service_ProviderObjectID
Base Type
string
top
 

Catalog_ItemReferenceEnumeration

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

Purchase_ItemReferenceEnumeration

part of: Purchase_ItemObjectID
Base Type
string
top
 

ImageReferenceEnumeration

part of: ImageObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top