Get all the transaction type details for a terms of use definition
get
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses/{publicSectorTermsOfUsesUniqID}/child/TermsUsage
Request
Path Parameters
-
publicSectorTermsOfUsesUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId, EffectiveEndDate, EffectiveStartDate and TermsUseId ---for the Terms Of Use Definitions resource and used to uniquely identify an instance of Terms Of Use Definitions. The client should not generate the hash key value. Instead, the client should query on the Terms Of Use Definitions collection resource with a filter on the primary key values in order to navigate to a specific instance of Terms Of Use Definitions.
For example: publicSectorTermsOfUses?q=AgencyId=<value1>;EffectiveEndDate=<value2>;EffectiveStartDate=<value3>;TermsUseId=<value4>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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:- PrimaryKey: Finds the transaction type that matches the primary keys specified. Finder Variables:
- AgencyId; integer; The agency ID for a terms of use definition.
- EffectiveEndDate; string; The effective end date for a terms of use definition.
- EffectiveStartDate; string; The effective start date for a terms of use definition.
- Product; string; The transaction type for which the terms content is enabled or disabled
- TermsUseId; string; The unique identifier for a terms of use definition.
- PrimaryKey: Finds the transaction type that matches the primary keys specified. Finder Variables:
-
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.
-
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 attributes. 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 -
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".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorTermsOfUses-TermsUsage
Type:
Show Source
object
-
count(optional):
integer
Title:
Count
The number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMore
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(optional):
array Items
Title:
Items
The items in the collection. -
limit(optional):
integer
Title:
Limit
The actual paging size used by the server. -
links(optional):
array Items
Title:
Items
The link relations associated with the resource instance. -
offset(optional):
integer
Title:
Offset
The offset value used in the current page.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorTermsOfUses-TermsUsage-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier for an agency that is associated with a terms of use definition.
-
CreatedBy(optional):
string
Maximum Length:
64
The user who added the transaction type to the terms of use definition. -
CreationDate(optional):
string(date-time)
The date and time that the transaction type was added to the terms of use definition.
-
Description(optional):
string
Title:
Description
Maximum Length:100
The description of the terms of use definition. -
EffectiveEndDate(optional):
string(date)
The effective end date of the terms of use definition.
-
EffectiveStartDate(optional):
string(date)
The effective start date of the terms of use definition.
-
EnabledFlag(optional):
string
Maximum Length:
1
Indicates whether the terms of use definition is enabled for the transaction type. If the value is Y, terms of use definition is enabled. The default value is N. -
LastUpdateDate(optional):
string(date-time)
The date and time that the transaction type was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the transaction type. -
links(optional):
array Items
Title:
Items
Link Relations -
ObjectVersionNumber(optional):
integer(int32)
Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
Product(optional):
string
Maximum Length:
30
The transaction type for which the terms content is enabled or disabled. -
TermsUseId(optional):
string
Maximum Length:
15
The unique identifier for a terms of use definition.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.