Service Directory > v32.1 > Inventory > Get_Inventory_Label_Template_Rules
 

Operation: Get_Inventory_Label_Template_Rules

This web service operation is used to retrieve Inventory Label Template Rules for Label Printing


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

Get Request Element for Get Label Template Rules
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Inventory_Label_Template_Rule_Request_References  [0..1]  Element containing references to other objects in a Label Template Rule   
Request_Criteria [Choice]   Inventory_Label_Template_Rule_Request_Criteria  [0..1]  Request Criteria for Put Label Template Rules   
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_Inventory_Label_Template_Rules_Response

Response Element for Get Label Template Rules
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Inventory_Label_Template_Rule_Request_References  [0..1]  Element containing references to other objects in a Label Template Rule   
Request_Criteria  Inventory_Label_Template_Rule_Request_Criteria  [0..1]  Request Criteria for Put Label Template Rules   
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  Inventory_Label_Template_Rule_Response_Data  [0..1]  Response Data Element for Label Template Rules   
top
 

Inventory_Label_Template_Rule_Request_References

part of: Get_Inventory_Label_Template_Rules_Response, Get_Inventory_Label_Template_Rules_Request
Element containing references to other objects in a Label Template Rule
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Label_Template_Rule_Reference  Inventory_Label_Template_RuleObject  [1..*]  Element containing references to other objects in a Label Template Rule   
top
 

Inventory_Label_Template_RuleObject

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

Inventory_Label_Template_RuleObjectID

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

Inventory_Label_Template_Rule_Request_Criteria

part of: Get_Inventory_Label_Template_Rules_Response, Get_Inventory_Label_Template_Rules_Request
Request Criteria for Put Label Template Rules
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Inventory_Label_Template_Rules_Response, Get_Inventory_Label_Template_Rules_Request
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_Inventory_Label_Template_Rules_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
 

Inventory_Label_Template_Rule_Response_Data

part of: Get_Inventory_Label_Template_Rules_Response
Response Data Element for Label Template Rules
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Label_Template_Rule  Inventory_Label_Template_Rule  [0..*]  Element to contain information about a Label Template Rule   
top
 

Inventory_Label_Template_Rule

part of: Inventory_Label_Template_Rule_Response_Data
Label Template Rule Element for Label Template Rule Web Services
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Label_Template_Rule_Reference  Inventory_Label_Template_RuleObject  [0..1]  Label Template Rule itself   
Inventory_Label_Template_Rule_Data  Inventory_Label_Template_Rule_Data  [0..*]  Data contained within a Label Template Rule.   
top
 

Inventory_Label_Template_Rule_Data

part of: Inventory_Label_Template_Rule
Element with data in a Label Template Rule
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Label_Template_Rule_ID  string  [0..1]  Label Template Rule Reference ID   
Label_Template_Rule_Order  string  [0..1]  Label Template Rule Order   
Label_Type_Reference  Inventory_Label_TypeObject  [1..1]  Inventory Label Type Reference ID   
Company_Reference  OrganizationObject  [0..*]  Company/Companies for Label Template Rules   
Location_Usage_Reference  Location_UsageObject  [0..*]  Location Usage/Usages for Label Template Rules   
Site_Reference  LocationObject  [0..*]  Inventory Site/Sites for Label Template Rules   
Location_Reference  Asset_Location_or_Location_HierarchyObject  [0..*]  Location/Locations for Label Template Rules   
Ship-To_Address_Reference  Address_ReferenceObject  [0..*]  Ship-To Address for Label Template Rules   
Deliver-To_Location_Reference  LocationObject  [0..*]  Deliver-To Location for Label Template Rules   
Supplier_Reference  Resource_ProviderObject  [0..*]  Supplier/Suppliers for Label Template Rules   
Spend_Category_Reference  Spend_CategoryObject  [0..*]  Spend Category/Categories for Label Template Rules   
Manufacturer_Reference  ManufacturerObject  [0..*]  Manufacturer/Manufacturers for Label Template Rules   
Stocking_Unit_of_Measure_Reference  Unit_of_MeasureObject  [0..*]  Unit of Measure/Measures for Label Template Rules   
Purchase_Item_Group_Reference  Purchase_Item_GroupObject  [0..*]  Purchase Item Group/Groups for Label Template Rules   
Item_Reference  Item_DescriptorObject  [0..*]  Item/Items for Label Template Rules   
Include_Blank_Delivery_Type_Reference  boolean  [0..1]  Check for an intended blank delivery type   
Delivery_Type_Reference  Delivery_TypeObject  [0..*]  Delivery Type for Label Template Rule   
Purchase_Order_Type_Reference  Order_TypeObject  [0..*]  Order Type for Label Template Rule   
Resulting_Label_Template  string  [1..1]  Resulting Label Template for Label Template Rules   
Label_Printing_Unit_of_Measure_Reference  Unit_of_Measure_OptionObject  [0..1]  Label Printing Unit of Measure for Label Template Rules   
Integration_System_Reference  Integration_System__Audited_Object  [0..1]  Integration System for Label Template Rules   
Do_Not_Print  boolean  [0..1]  Do Not Print option for Label Template Rules   
top
 

Inventory_Label_TypeObject

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

Inventory_Label_TypeObjectID

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

OrganizationObject

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

Location_UsageObject

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

Location_UsageObjectID

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

LocationObject

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

LocationObjectID

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

Asset_Location_or_Location_HierarchyObject

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

Asset_Location_or_Location_HierarchyObjectID

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

Address_ReferenceObject

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

Address_ReferenceObjectID

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

Spend_CategoryObject

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

ManufacturerObject

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

ManufacturerObjectID

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

Unit_of_MeasureObject

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

Purchase_Item_GroupObject

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

Purchase_Item_GroupObjectID

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

Item_DescriptorObject

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

Item_DescriptorObjectID

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

Delivery_TypeObject

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

Delivery_TypeObjectID

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

Order_TypeObject

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

Order_TypeObjectID

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

Unit_of_Measure_OptionObject

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

Unit_of_Measure_OptionObjectID

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

Integration_System__Audited_Object

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

Integration_System__Audited_ObjectID

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

Inventory_Label_Template_RuleReferenceEnumeration

part of: Inventory_Label_Template_RuleObjectID
Base Type
string
top
 

Inventory_Label_TypeReferenceEnumeration

part of: Inventory_Label_TypeObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Location_UsageReferenceEnumeration

part of: Location_UsageObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Asset_Location_or_Location_HierarchyReferenceEnumeration

part of: Asset_Location_or_Location_HierarchyObjectID
Base Type
string
top
 

Address_ReferenceReferenceEnumeration

part of: Address_ReferenceObjectID
Base Type
string
top
 

Resource_ProviderReferenceEnumeration

part of: Resource_ProviderObjectID
Base Type
string
top
 

Spend_CategoryReferenceEnumeration

part of: Spend_CategoryObjectID
Base Type
string
top
 

ManufacturerReferenceEnumeration

part of: ManufacturerObjectID
Base Type
string
top
 

Unit_of_MeasureReferenceEnumeration

part of: Unit_of_MeasureObjectID
Base Type
string
top
 

Purchase_Item_GroupReferenceEnumeration

part of: Purchase_Item_GroupObjectID
Base Type
string
top
 

Item_DescriptorReferenceEnumeration

part of: Item_DescriptorObjectID
Base Type
string
top
 

Delivery_TypeReferenceEnumeration

part of: Delivery_TypeObjectID
Base Type
string
top
 

Order_TypeReferenceEnumeration

part of: Order_TypeObjectID
Base Type
string
top
 

Unit_of_Measure_OptionReferenceEnumeration

part of: Unit_of_Measure_OptionObjectID
Base Type
string
top
 

Integration_System__Audited_ReferenceEnumeration

part of: Integration_System__Audited_ObjectID
Base Type
string
top