Get all set ID sets
get
http://servername/fscmRestApi/resources/11.13.18.05/setIdSets
get
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:- PrimaryKey :Finds the set ID set with the given primary key.
Finder Variables:- SetId :The unique identifier of the set ID set.
- SetCodeFinder :Finds the set ID set for the given set ID set code.
Finder Variables:- SetCode :The unique code that identifies the set ID set.
- PrimaryKey :Finds the set ID set with the given primary key.
-
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 -
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
- application/vnd.oracle.adf.resourcecollection+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.
Nested Schema : setIdSets_item-response
Match All
Show Source
-
object
Set ID Set
Title:
Set ID Set
The set ID sets list of values resource is used to query the set ID sets. -
object
__busObj_context
-
object
setIdSets_item-response-allOf[2]
Nested Schema : Set ID Set
Type:
object
Title:
Set ID Set
The set ID sets list of values resource is used to query the set ID sets.
Show Source
-
$sourceLang: string
Read Only:
true
-
createdBy: string
Title:
Created By
Read Only:true
The user who created the record. -
description: string
Title:
Set Description
Read Only:true
The description of the set ID set. -
setCode: string
Title:
Set Code
Read Only:true
The unique code that identifies the set ID set. -
setId: string
(big-integer)
Title:
Set ID
Read Only:true
The unique identifier of the set ID set. -
setName: string
Title:
Set Name
Read Only:true
The descriptive name of the Set ID Set. -
timeCreated: string
(date-time)
Title:
Created On
Read Only:true
The date and time when the record was created. -
timeUpdated: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
updatedBy: string
Title:
Last Updated By
Read Only:true
The user who last updated the record.
Nested Schema : setIdSets-_translations_item-response
Match All
Show Source
-
object
oraCommonAppsInfraObjects.SetIdSetTranslation_item
The translation of the set ID set list of values resource.
-
object
__busObj_context
Nested Schema : oraCommonAppsInfraObjects.SetIdSetTranslation_item
Type:
object
The translation of the set ID set list of values resource.
Show Source
-
$language: string
Read Only:
true
-
$sourceLang: string
Read Only:
true
-
setId: string
(big-integer)
Read Only:
true
The unique identifier of the set ID set. -
setIdSet:
setIdSet
Nested Schema : setIdSet
Match All
Show Source
-
object
Set ID Set
Title:
Set ID Set
The set ID sets list of values resource is used to query the set ID sets. -
object
__busObj_context
Nested Schema : setIdSets-setIdAssignments_item-response
Match All
Show Source
-
object
Set ID Assignment
Title:
Set ID Assignment
The set ID assignment list of values resource. -
object
__busObj_context
Nested Schema : Set ID Assignment
Type:
object
Title:
Set ID Assignment
The set ID assignment list of values resource.
Show Source
-
createdBy: string
Title:
Created By
Read Only:true
The user who created the record. -
determinantType:
determinantType
-
determinantValue: string
(big-integer)
Title:
Determinant Value
Read Only:true
The set ID assignment determinant value. -
referenceGroup:
referenceGroup
-
referenceGroupName: string
Title:
Reference Group Name
Read Only:true
The unique identifier of the set ID reference group. -
setIdSet:
setIdSet
-
timeCreated: string
(date-time)
Title:
Created On
Read Only:true
The date and time when the record was created. -
timeUpdated: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
updatedBy: string
Title:
Last Updated By
Read Only:true
The user who last updated the record.
Nested Schema : referenceGroup
Match All
Show Source
-
object
Set ID Reference Group
Title:
Set ID Reference Group
The set ID reference groups list of values resource is used to query the set ID reference groups. -
object
__busObj_context
Nested Schema : setIdSet
Match All
Show Source
-
object
Set ID Set
Title:
Set ID Set
The set ID sets list of values resource is used to query the set ID sets. -
object
__busObj_context
Nested Schema : Set ID Reference Group
Type:
object
Title:
Set ID Reference Group
The set ID reference groups list of values resource is used to query the set ID reference groups.
Show Source
-
$sourceLang: string
Title:
$sourceLang
Read Only:true
-
applicationId: string
(big-integer)
Title:
Application ID
Read Only:true
The unique identifier of the application. -
createdBy: string
Title:
Created By
Read Only:true
The user who created the record. -
description: string
Title:
Reference Group Description
Read Only:true
The description of the reference group. -
determinantType: string
Title:
Determinant Type
Read Only:true
The unique identifier of the determinant type. -
referenceGroupName: string
Title:
Reference Group Name
Read Only:true
The unique identifier of the set ID reference group. -
timeCreated: string
(date-time)
Title:
Created On
Read Only:true
The date and time when the record was created. -
timeUpdated: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
updatedBy: string
Title:
Last Updated By
Read Only:true
The user who last updated the record. -
visibleGroupName: string
Title:
Visible Group Name
Read Only:true
The translated visible name of the set ID reference group.