Get a data selection query
get
/fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}
Request
Path Parameters
-
QueryId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : dataGetterQueries-item-response
Type:
Show Source
object
-
ConsumerCode: string
Title:
Consumer Code
Read Only:true
Maximum Length:50
Data selection tool consumer unique code, such as COMM, RULES, or ADMISSIONS. -
ConsumerId: integer
(int64)
Title:
Consumer ID
Data selection tool consumer unique identifier. -
ConsumerInstanceId: integer
Title:
Consumer Instance ID Value
Data selection tool consumer instance ID. -
ConsumerName: string
Title:
Consumer Name
Maximum Length:100
Name of the data selection tool consumer, such as the Fee discount calculation process. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the query. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time of the creation of the query. -
dataGetterQueryElements: array
Data Selection Tool Query Elements
Title:
Data Selection Tool Query Elements
Use the data selection tool query elements resource to view, create, modify, or delete query elements in data selection tool. This resource stores the elements of a query. -
dataGetterSubQueryUsages: array
Data Selection Tool Subquery Usages
Title:
Data Selection Tool Subquery Usages
Use the data selection tool subquery usages resource to view subquery usage information of a main query in data selection tool. -
Description: string
Title:
Description
Maximum Length:240
Description of the data selection tool query. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time of the last update of the query. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the query. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Query: string
Title:
Query
Data selection tool query object. This can be JSON or XML or a direct SQL query. -
QueryCode: string
Title:
Query Code
Maximum Length:50
Data selection tool query unique code. This is a global unique code that the application automatically generates, and is used for data migration purpose. -
QueryId: integer
(int64)
Title:
Query ID
Read Only:true
Data selection tool query unique identifier. -
QueryName: string
Title:
Query Name
Maximum Length:100
Name of the data selection tool query, such as Student fee calculation query. -
QueryStatusCode: string
Title:
Query Status Code
Maximum Length:30
Default Value:ORA_HEY_DRAFT
Data selection tool query status code, such as ORA_HEY_PUBLISHED, ORA_HEY_UNPUBLISHED
or ORA_HEY_DRAFT.
A list of accepted values is defined in the lookup type ORA_HEY_QUERY_STATUS_CODE. -
QueryStatusMeaning: string
Title:
Query Status
Read Only:true
Maximum Length:80
The meaning of data selection tool query status code, such as published, draft, or unpublished.A list of accepted values is defined in the lookup
type ORA_HEY_QUERY_STATUS_CODE. -
queryTagAssignments: array
Data Selection Tool Query Tag Assignments
Title:
Data Selection Tool Query Tag Assignments
Use the data selection tool query tag assignments resource to view, create, modify, or delete data selection tool query tag assignments. -
QueryTypeCode: string
Title:
Query Type Code
Maximum Length:30
Data selection query type code, such as ORA_HEY_ADHOC_QUERY or ORA_HEY_CONSUMER_QUERY. A list of accepted values is defined in the lookup type ORA_HEY_QUERY_TYPE. -
QueryTypeMeaning: string
Title:
Query Type
Read Only:true
Maximum Length:80
The meaning of data selection query type code, such as Ad hoc usage or Transaction.
A list of accepted values is defined in the lookup type ORA_HEY_QUERY_TYPE. -
SelectionToolId: integer
(int64)
Title:
Selection Tool ID
Data selection tool unique identifier. -
SelectionToolName: string
Title:
Selection Tool Name
Maximum Length:100
Name of the data selection tool. -
UseAsSubQueryFlag: boolean
Title:
Use as Subquery Indicator
Maximum Length:1
Indicates if a data selection tool query can be used as a subquery.
Nested Schema : Data Selection Tool Query Elements
Type:
array
Title:
Data Selection Tool Query Elements
Use the data selection tool query elements resource to view, create, modify, or delete query elements in data selection tool. This resource stores the elements of a query.
Show Source
Nested Schema : Data Selection Tool Subquery Usages
Type:
array
Title:
Data Selection Tool Subquery Usages
Use the data selection tool subquery usages resource to view subquery usage information of a main query in data selection tool.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Data Selection Tool Query Tag Assignments
Type:
array
Title:
Data Selection Tool Query Tag Assignments
Use the data selection tool query tag assignments resource to view, create, modify, or delete data selection tool query tag assignments.
Show Source
Nested Schema : dataGetterQueries-dataGetterQueryElements-item-response
Type:
Show Source
object
-
ArtifactId: integer
(int64)
Title:
Artifact ID
Data resource unique identifier. -
ArtifactName: string
Title:
Artifact Name
Maximum Length:50
Name of a data resource. -
ElementCode: string
Title:
Element Code
Read Only:true
Maximum Length:50
Artifact element code. -
ElementId: integer
(int64)
Title:
Element ID
Artifact element unique identifier. -
ElementName: string
Title:
Element Name
Maximum Length:50
Name of a data artifact element. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QueryElementId: integer
(int64)
Title:
Query Element ID
Data selection query and artifact element mapping unique identifier.
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.
Nested Schema : dataGetterQueries-dataGetterSubQueryUsages-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SubQueryCode: string
Title:
Subquery Code
Read Only:true
Maximum Length:255
Data selection tool subquery unique code. -
SubQueryId: integer
(int64)
Title:
Subquery ID
Read Only:true
Data selection tool subquery unique identifier. -
SubQueryName: string
Title:
Subquery Name
Read Only:true
Maximum Length:255
Name of the data selection tool subquery, such as Student fee calculation query.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : dataGetterQueries-queryTagAssignments-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TagAssignmentId: integer
(int64)
Title:
Tag Assignment ID
The tag assignment identifier of the data selection query tag. -
TagCode: string
Maximum Length:
30
The tag code of the data selection query tag. -
TagDescription: string
Read Only:
true
Maximum Length:240
The tag description of the data selection query tag. -
TagId: integer
(int64)
Title:
Tag ID
The tag identifier of the data selection query tag. -
TagName: string
Read Only:
true
Maximum Length:64
The tag name of the data selection query tag.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- dataGetterConsumersLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: ConsumerName; Target Attribute: ConsumerName
- Display Attribute: ConsumerName
- dataGetterQueryElements
-
Operation: /fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}/child/dataGetterQueryElementsParameters:
- QueryId:
$request.path.QueryId
Use the data selection tool query elements resource to view, create, modify, or delete query elements in data selection tool. This resource stores the elements of a query. - QueryId:
- dataGetterSelectionToolsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: SelectionToolName; Target Attribute: SelectionToolId
- Display Attribute: SelectionToolName
- dataGetterSubQueryUsages
-
Operation: /fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}/child/dataGetterSubQueryUsagesParameters:
- QueryId:
$request.path.QueryId
Use the data selection tool subquery usages resource to view subquery usage information of a main query in data selection tool. - QueryId:
- heyLookupsLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_QUERY_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: QueryTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- heyLookupsStatusLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_QUERY_STATUS_CODE
The following properties are defined on the LOV link relation:- Source Attribute: QueryStatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- queryTagAssignments
-
Parameters:
- QueryId:
$request.path.QueryId
Use the data selection tool query tag assignments resource to view, create, modify, or delete data selection tool query tag assignments. - QueryId: