Service Directory > v31.2 > Resource_Management > Get_Company_Asset_Book_Restrictions
 

Operation: Get_Company_Asset_Book_Restrictions

Company asset book restrictions for company asset books can be retrieved according to company. Restrictions are ordered.


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

Request element for the company asset book restrictions operation
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Company_Asset_Book_Restriction_Request_References  [0..1]  Element containing request references for the company asset book restrictions operation   
Request_Criteria [Choice]   Company_Asset_Book_Restriction_Request_Criteria  [0..1]  Element containing request criteria for the company asset book restrictions operation.   
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_Group  Company_Asset_Book_Restriction_Response_Group  [0..1]  Element containing response group for the company asset book restrictions operation   
top
 

Response Element: Get_Company_Asset_Book_Restrictions_Response

Element containing request and response elements for the company asset book restriction operation
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Company_Asset_Book_Restriction_Request_References  [0..1]  Element containing request references for the company asset book restrictions operation   
Request_Criteria  Company_Asset_Book_Restriction_Request_Criteria  [0..1]  Element containing request criteria for the company asset book restrictions operation.   
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_Group  Company_Asset_Book_Restriction_Response_Group  [0..1]  Element containing response group for the company asset book restrictions operation   
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  Company_Asset_Book_Restriction_Response_Data  [0..1]  Response data for the company asset book restriction operation   
top
 

Company_Asset_Book_Restriction_Request_References

part of: Get_Company_Asset_Book_Restrictions_Response, Get_Company_Asset_Book_Restrictions_Request
Element containing request references for the company asset book restrictions operation
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [1..*]  Company references for company asset book restrictions   
top
 

CompanyObject

part of: Company_Asset_Book_Restrictions_Data, Company_Asset_Book_Restriction_Request_References, Company_Asset_Book_Restriction, Company_Asset_Book_Restriction_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  CompanyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CompanyObjectID

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

Company_Asset_Book_Restriction_Request_Criteria

part of: Get_Company_Asset_Book_Restrictions_Response, Get_Company_Asset_Book_Restrictions_Request
Element containing request criteria for the company asset book restrictions operation.
 
Parameter name Type/Value Cardinality Description Validations
Companies_Reference  CompanyObject  [0..*]  Company reference for company asset book restriction   
top
 

Response_Filter

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

Company_Asset_Book_Restriction_Response_Group

part of: Get_Company_Asset_Book_Restrictions_Response, Get_Company_Asset_Book_Restrictions_Request
Element containing response group for the company asset book restrictions operation
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Results

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

Company_Asset_Book_Restriction_Response_Data

part of: Get_Company_Asset_Book_Restrictions_Response
Response data for the company asset book restriction operation
 
Parameter name Type/Value Cardinality Description Validations
Company_Asset_Book_Restriction  Company_Asset_Book_Restriction  [0..*]  Element for company asset book restriction operation   
top
 

Company_Asset_Book_Restriction

part of: Company_Asset_Book_Restriction_Response_Data
Element for company asset book restriction operation
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [1..1]  Company reference, used as a reference criteria   
Company_Asset_Book_Restriction_Data  Company_Asset_Book_Restrictions_Data  [0..*]  Data element for company asset book restrictions operation   
top
 

Company_Asset_Book_Restrictions_Data

part of: Company_Asset_Book_Restriction
Element for create, update, or delete Company Asset Book Restrictions by Company.
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [1..1]  Company reference for company asset book restrictions   
Company_Asset_Book_Restriction_Replacement_Data  Company_Asset_Book_Restriction_Replacement_Data  [0..*]  Element containing Company Asset Book Restriction replacement data. 
Validation Description
Valid ID must be provided when Delete flag is set.  Valid ID must be provided when Delete flag is set. 
Add Only Flag is set and ID already exists for Company Asset Book Restriction. Use a unique ID to create a Company Asset Book Restriction.  Add Only Flag is set and ID already exists for Company Asset Book Restriction. Use a unique ID to create a Company Asset Book Restriction. 
Primary Book Override must be included within Restricted to Books.  Primary Book Override must be included within Restricted to Books. 
[missing required parm] is required to create or update a Company Asset Book Restriction.  Company Asset Book Restriction Order, Restrict to Books Reference, and Primary Asset Book Reference are required to create or update a Company Asset Book Restriction. 
The Company Asset Book Restriction cannot be updated, it does not match the Company of the request.  The Company Asset Book Restriction cannot be updated, it does not match the Company of the request. 
The specified Asset Book is not configured for the Company.  The specified Asset Book is not configured for the Company. 
Primary Book Override must be the Primary Book if specified within Restricted to Books.  Primary Book Override must be the Primary Book if specified within Restricted to Books. 
Primary Book Override must be an accounting book.   
You can only select Supplier Contract types that have Receive Contract Lines.   
You can only select ROU Depreciation Expense for the Lease Accounting Method.   
 
top
 

Company_Asset_Book_Restriction_Replacement_Data

part of: Company_Asset_Book_Restrictions_Data
Element containing Company Asset Book Restriction replacement data.
 
Parameter name Type/Value Cardinality Description Validations
Delete  boolean  [0..1]  Flag indicating the referenced Company Asset Book Restriction should be deleted from the Company.   
ID  string  [0..1]  This is a unique reference identifier to the set of Company Asset Book Restrictions.   
Company_Asset_Book_Restriction_Order  string  [0..1]  Used to define the order of the rules (ascending). 
Validation Description
A Company Asset Book Restriction with this order already exists.   
 
Spend_Category_or_Hierarchy_Reference  Spend_Category_or_HierarchyObject  [0..*]  Reference to Spend Categories or Hierarchies for a Company Asset Book Restriction.   
Supplier_Contract_Type_Reference  Supplier_Contract_TypeObject  [0..*]  Reference to Supplier Contract Types for a Company Asset Book Restriction.   
Lease_Accounting_Method_Reference  Lease_Accounting_MethodObject  [0..*]  Reference to Lease Accounting Methods for a Company Asset Book Restriction.   
Restrict_to_Asset_Book_Reference  Asset_BookObject  [0..*]  Reference to the restricted books for a company asset book restriction   
Primary_Asset_Book_Override_Reference  Asset_BookObject  [0..1]  Reference to the primary override for a company asset book restriction   
Validation Description
Valid ID must be provided when Delete flag is set.  Valid ID must be provided when Delete flag is set. 
Add Only Flag is set and ID already exists for Company Asset Book Restriction. Use a unique ID to create a Company Asset Book Restriction.  Add Only Flag is set and ID already exists for Company Asset Book Restriction. Use a unique ID to create a Company Asset Book Restriction. 
Primary Book Override must be included within Restricted to Books.  Primary Book Override must be included within Restricted to Books. 
[missing required parm] is required to create or update a Company Asset Book Restriction.  Company Asset Book Restriction Order, Restrict to Books Reference, and Primary Asset Book Reference are required to create or update a Company Asset Book Restriction. 
The Company Asset Book Restriction cannot be updated, it does not match the Company of the request.  The Company Asset Book Restriction cannot be updated, it does not match the Company of the request. 
The specified Asset Book is not configured for the Company.  The specified Asset Book is not configured for the Company. 
Primary Book Override must be the Primary Book if specified within Restricted to Books.  Primary Book Override must be the Primary Book if specified within Restricted to Books. 
Primary Book Override must be an accounting book.   
You can only select Supplier Contract types that have Receive Contract Lines.   
You can only select ROU Depreciation Expense for the Lease Accounting Method.   
top
 

Spend_Category_or_HierarchyObject

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

Spend_Category_or_HierarchyObjectID

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

Supplier_Contract_TypeObject

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

Supplier_Contract_TypeObjectID

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

Lease_Accounting_MethodObject

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

Lease_Accounting_MethodObjectID

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

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

Asset_BookObjectID

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

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Spend_Category_or_HierarchyReferenceEnumeration

part of: Spend_Category_or_HierarchyObjectID
Base Type
string
top
 

Supplier_Contract_TypeReferenceEnumeration

part of: Supplier_Contract_TypeObjectID
Base Type
string
top
 

Lease_Accounting_MethodReferenceEnumeration

part of: Lease_Accounting_MethodObjectID
Base Type
string
top
 

Asset_BookReferenceEnumeration

part of: Asset_BookObjectID
Base Type
string
top