Get all related business units
get
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessUnits
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- BuAltKeyByName
Finder Variables:- EnterpriseId
- Name
- BuAltKeyByShortCode
Finder Variables:- EnterpriseId
- ShortCode
- PrimaryKey
Finder Variables:- BusinessUnitId
- BuAltKeyByName
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- BusinessUnitId; integer; The key identifier of the business unit in the organization.
- DefaultCurrencyCode; string; The currency code that is used by the business unit.
- DefaultSetId; string; The key identifier for the reference data set that is shared across business units and other entities. The reference data set is used to filter the reference data in the transactional interface.
- EnabledForHrFlag; string; Indicates that the business unit is available to be used by the Human Resource.
- EnterpriseId; integer; The enterprise ID of the tenant in a multi-tenant environment.
- FinancialsBusinessUnitId; string; The key Identifier of the financial business unit in the organization.
- LegalEntityId; string; The key identifier of the legal employer.
- LocationId; integer; The key identifier of the location.
- Name; string; The name of the business unit.
- PrimaryLedgerId; string; The key identifier for the set of books associated with the business unit.
- ProfitCenterFlag; string; The business unit that is identified as a profit center.
- ShortCode; string; The unique identifier of the business unit.
- Status; string; Indicates that the business unit is used for Financials.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorBusinessUnits
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorBusinessUnits-item-response
Type:
Show Source
object
-
BusinessUnitId: integer
(int64)
Title:
Business Unit ID
Read Only:true
The key identifier of the business unit in the organization. -
CreatedBy: string
Title:
Business Unit Created By
Read Only:true
Maximum Length:64
The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Business Unit Creation Date
Read Only:true
The date and time when the row was created. -
DefaultCurrencyCode: string
Title:
Default Currency
Read Only:true
Maximum Length:150
The currency code that is used by the business unit. -
DefaultSetId: string
Read Only:
true
Maximum Length:150
The key identifier for the reference data set that is shared across business units and other entities. The reference data set is used to filter the reference data in the transactional interface. -
EnabledForHrFlag: string
Title:
Enabled
Read Only:true
Maximum Length:150
Indicates that the business unit is available to be used by the Human Resource. -
EnterpriseId: integer
(int64)
Read Only:
true
The enterprise ID of the tenant in a multi-tenant environment. -
FinancialsBusinessUnitId: string
Read Only:
true
Maximum Length:150
The key Identifier of the financial business unit in the organization. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The name of the user who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login details of the user who last updated the row. -
LegalEntityId: string
Read Only:
true
Maximum Length:150
The key identifier of the legal employer. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
Read Only:
true
The key identifier of the location. -
Name: string
Title:
Business Unit
Read Only:true
Maximum Length:240
The name of the business unit. -
PrimaryLedgerId: string
Read Only:
true
Maximum Length:150
The key identifier for the set of books associated with the business unit. -
ProfitCenterFlag: string
Title:
Below legal entity
Read Only:true
Maximum Length:150
The business unit that is identified as a profit center. -
ShortCode: string
Title:
Code
Read Only:true
Maximum Length:150
The unique identifier of the business unit. -
Status: string
Title:
Active
Read Only:true
Maximum Length:30
Indicates that the business unit is used for Financials.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.