Get a data selection query version
get
/fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}/child/dataGetterQueryVersions/{QueryVersionId}
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=
-
QueryVersionId(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: string
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: string
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 : dataGetterQueries-dataGetterQueryVersions-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the query version was created. -
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. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the query version was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The person who updated the query version. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Query: string
(byte)
Title:
Query
Data selection tool query object. This can be JSON or XML or a direct SQL query. -
queryFilterParameters: array
Query Filter Parameters
Title:
Query Filter Parameters
Query filter parameters document the parameters that are configured for a data selection query filter. When a query is run, the bind parameter is used to pass values to the query filter. -
QueryStatusCode: string
Title:
Query Status Code
Maximum Length:30
The status code of a query version definition. -
QueryStatusMeaning: string
Title:
Status Meaning
Read Only:true
Maximum Length:80
The meaning of the current query version status code. A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS. -
QueryVersionId: integer
(int64)
Title:
Query Version ID
The unique identifier of a query version definition. -
VersionDescription: string
Title:
Version Description
Maximum Length:240
The description of a query version definition. -
VersionName: string
Title:
Version Name
Maximum Length:50
The name of a query version definition. -
VersionNumber: integer
(int32)
Title:
Version Number
Read Only:true
The version number of the query definition.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Query Filter Parameters
Type:
array
Title:
Query Filter Parameters
Query filter parameters document the parameters that are configured for a data selection query filter. When a query is run, the bind parameter is used to pass values to the query filter.
Show Source
Nested Schema : dataGetterQueries-dataGetterQueryVersions-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
Read Only:true
Data selection query and artifact element mapping unique identifier. -
RequestAction: string
Title:
Request Action
Maximum Length:80
The request action that's performed by the resource when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.
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-dataGetterQueryVersions-queryFilterParameters-item-response
Type:
Show Source
object
-
ArtifactCode: string
Title:
Artifact Code
Read Only:true
Maximum Length:50
The unique code of the list of values data artifact resource. -
ArtifactName: string
Title:
Artifact Name
Read Only:true
Maximum Length:50
The name of the list of values data artifact resource. -
DefaultValue: string
Title:
Default Value
Maximum Length:512
The default value of a data selection filter bind parameter attribute. -
DefaultValueJson: string
(byte)
Title:
Default Value JSON Format
Default value of the attribute in JSON format. Used by list variables. -
FilterParamCode: string
Title:
Filter Parameter Code
Read Only:true
Maximum Length:50
Default Value:ORA_HEY_SINGLE_VARIABLE
The data selection filter bind parameter unique code, such as UNIT_GRADE. -
FilterParamDataTypeCode: string
Title:
Filter Parameter Data Type Code
Maximum Length:30
The data selection filter bind parameter attribute data type code, for example, a string, number, or date. A list of accepted values is defined in the lookup type ORA_HEY_ATTRIBUTE_TYPE. -
FilterParamDataTypeMeaning: string
Title:
Filter Parameter Data Type
Read Only:true
Maximum Length:80
The meaning of the data selection filter bind parameter attribute data type code, for example, a string, number, or date. A list of accepted values is defined in the lookup type ORA_HEY_ATTRIBUTE_TYPE. -
FilterParamDescription: string
Title:
Filter Parameter Description
Maximum Length:240
The description of a data selection filter bind parameter. -
FilterParamId: integer
(int64)
Title:
Filter Parameter ID
Read Only:true
The unique identifier of a data selection filter bind parameter. -
FilterParamName: string
Title:
Filter Parameter Name
Maximum Length:60
The name of a data selection filter bind parameter. -
FilterParamTypeCode: string
Title:
Filter Parameter Type Code
Maximum Length:30
The data selection filter bind parameter type code, for example, a simple variable, list variable, or multicolumn list variable. A list of accepted values is defined in the lookup type ORA_HEY_VARIABLE_TYPE_CODE. The default value is ORA_HEY_SINGLE_VARIABLE. -
FilterParamTypeMeaning: string
Title:
Filter Parameter Type
Read Only:true
Maximum Length:80
The meaning of the data selection filter bind parameter type code, for example, a simple variable, list variable or multicolumn list variable. A list of accepted values is defined in the lookup type ORA_HEY_VARIABLE_TYPE_CODE. The default value is Single variable. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupTypeCode: string
Title:
List of Values Lookup Type
Maximum Length:30
The list of values lookup type of a data selection filter bind parameter attribute. -
LovArtifactId: integer
(int64)
Title:
List of Values ID
The list of values data artifact resource ID of a data selection filter bind parameter attribute. -
LovDisplayFields: string
Title:
List of Values Display Fields
Maximum Length:900
The comma separated display field names of the list of values resource associated with this attribute. These field names can be displayed on the UI. -
LovFinder: string
Title:
List of Values Finder Name
Maximum Length:900
The list of values finder of a data selection filter bind parameter attribute. -
LovResourceName: string
Title:
List of Values Source Resource Name
Maximum Length:200
The source resource name for the list of values resource of a data selection filter bind parameter attribute. -
LovValueField: string
Title:
List of Values Field
Maximum Length:900
The field name of the list of values resource associated with this attribute. -
RequestAction: string
Title:
Request Action
Maximum Length:80
The request action that's performed by the resource when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE. -
RequiredFlag: boolean
Title:
Required
Maximum Length:1
Default Value:false
Indicates whether a data selection filter bind parameter attribute is required or not. If true then the bind parameter is required, else the bind parameter isn't required.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- QueryStatusCodeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupCode%3D{QueryStatusCode}%2CLookupType%3DORA_HEY_VERSION_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: QueryStatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- dataGetterQueryElements
-
Parameters:
- QueryId:
$request.path.QueryId
- QueryVersionId:
$request.path.QueryVersionId
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:
- queryFilterParameters
-
Parameters:
- QueryId:
$request.path.QueryId
- QueryVersionId:
$request.path.QueryVersionId
Query filter parameters document the parameters that are configured for a data selection query filter. When a query is run, the bind parameter is used to pass values to the query filter. - QueryId: