Get all business entity audits
get
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessEntityAudits
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:- BusinessAuditFinder: Find business entity audits.
Finder Variables:- businessObjectName; string; A business object Identifier.
- eventDateOperator; string; The activity date operator.
- eventFromDate; string; The activity from date.
- eventToDate; string; The activity to date.
- forEventType; string; The activity type.
- keyValue; string; A key name and its corresponding value.
- searchText; string; The text to search.
- PrimaryKey: Find the business entity audits that match primary key criteria.
Finder Variables:- attribute; string; The attribute.
- description; string; A key value pair.
- eventTime; string; The activity time.
- BusinessAuditFinder: Find business entity audits.
-
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:- attribute; string; The attribute.
- attributeDetails; string; The attribute details.
- attributeName; string; The attribute name.
- businessObject; string; A business object.
- contextNameOne; string
- contextNameThree; string
- contextNameTwo; string
- contextValueOne; string
- contextValueThree; string
- contextValueTwo; string
- dateOperator; string; The activity date operator.
- description; string; A key value pair to uniquely identify the business object audits.
- eventTime; string; The activity time.
- eventType; string; The activity type.
- fromDate; string; The activity from date.
- getSearchParam; string; The search text.
- includeChildObjects; string; The identifier whether to include child objects or not.
- newValue; string; The new value.
- objectName; string; The objects identifier.
- oldValue; string; The old value.
- optionalParam; string; The optional parameters.
- qualifiedBusinessObject; string; A qualified path for the business object.
- qualifiedChildBusinessObject; string; A qualified path for the child business object.
- reqParam; string; The required parameters.
- toDate; string; The activity to date.
- userInternalName; string; The internal user name.
- userName; string; The user who performed the activity.
-
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:
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.
Root Schema : publicSectorBusinessEntityAudits
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 : publicSectorBusinessEntityAudits-item-response
Type:
Show Source
object
-
attribute: string
Maximum Length:
255
The attribute. -
attributeDetails: string
The attribute details.
-
attributeName: string
Title:
Field Name
Maximum Length:255
The attribute name. -
businessObject: string
Title:
Modified Object
A business object. -
contextNameOne: string
Maximum Length:
255
-
contextNameThree: string
Maximum Length:
255
-
contextNameTwo: string
Maximum Length:
255
-
contextValueOne: string
Maximum Length:
255
-
contextValueThree: string
Maximum Length:
255
-
contextValueTwo: string
Maximum Length:
255
-
dateOperator: string
Maximum Length:
255
The activity date operator. -
description: string
A key value pair to uniquely identify the business object audits.
-
eventTime: string
(date-time)
Title:
Activity Date
The activity time. -
eventType: string
Title:
Activity
The activity type. -
fromDate: string
The activity from date.
-
getSearchParam: string
Maximum Length:
255
The search text. -
includeChildObjects: string
The identifier whether to include child objects or not.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
newValue: string
Title:
New Value
Maximum Length:255
The new value. -
objectName: string
Maximum Length:
255
The objects identifier. -
oldValue: string
Title:
Old Value
Maximum Length:255
The old value. -
optionalParam: string
Maximum Length:
255
The optional parameters. -
qualifiedBusinessObject: string
A qualified path for the business object.
-
qualifiedChildBusinessObject: string
Maximum Length:
255
A qualified path for the child business object. -
reqParam: string
Maximum Length:
255
The required parameters. -
toDate: string
The activity to date.
-
userInternalName: string
The internal user name.
-
userName: string
Title:
Activity By
The user who performed the activity.
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.