1. REST API for Oracle Fusion Cloud Student Management
  2. Tasks
  3. Data Selection Tool Queries
  4. Data Selection Tool Query Versions

Get all data selection query versions

get

/fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}/child/dataGetterQueryVersions

Request

Path Parameters
  • 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
  • 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>
  • 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).
  • 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
  • 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 all data selection query versions that match the primary key criteria specified.
      Finder Variables
      • QueryVersionId; integer; Unique identifier for the data selection query version.
    • WorkingQueryVersionFinder Finds the working query version, defined as the latest relevant version of the query. This is either the published version, the latest updated draft version, or the latest updated unpublished version.
      Finder Variables
    • 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.
    • 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
    • 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.
    • The resource item payload will be filtered in order to contain only data (no links section, for example).
    • 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
    • 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:
      • CreationDate; string; The date and time when the query version was created.
      • LastUpdateDate; string; The date and time when the query version was updated.
      • LastUpdatedBy; string; The person who updated the query version.
      • Query; string; Data selection tool query object. This can be JSON or XML or a direct SQL query.
      • QueryStatusCode; string; The status code of a query version definition.
      • QueryStatusMeaning; string; 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; The unique identifier of a query version definition.
      • VersionDescription; string; The description of a query version definition.
      • VersionName; string; The name of a query version definition.
      • VersionNumber; integer; The version number of the query definition.
    • 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
    • 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".
    • 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 Top

    Response

    Supported Media Types

    Default Response

    The following table describes the default response for this task.
    Headers
    • 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".
    • 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.
    Body ()
    Root Schema : dataGetterQueries-dataGetterQueryVersions
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : dataGetterQueries-dataGetterQueryVersions-item-response
    Type: object
    Show Source
    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 : 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: object
    Show Source
    Nested Schema : dataGetterQueries-dataGetterQueryVersions-queryFilterParameters-item-response
    Type: object
    Show Source
    • Title: Artifact Code
      Read Only: true
      Maximum Length: 50
      The unique code of the list of values data artifact resource.
    • Title: Artifact Name
      Read Only: true
      Maximum Length: 50
      The name of the list of values data artifact resource.
    • Title: Default Value
      Maximum Length: 512
      The default value of a data selection filter bind parameter attribute.
    • Title: Default Value JSON Format
      Default value of the attribute in JSON format. Used by list variables.
    • 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.
    • 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.
    • 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.
    • Title: Filter Parameter Description
      Maximum Length: 240
      The description of a data selection filter bind parameter.
    • Title: Filter Parameter ID
      Read Only: true
      The unique identifier of a data selection filter bind parameter.
    • Title: Filter Parameter Name
      Maximum Length: 60
      The name of a data selection filter bind parameter.
    • 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.
    • 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
    • Title: List of Values Lookup Type
      Maximum Length: 30
      The list of values lookup type of a data selection filter bind parameter attribute.
    • Title: List of Values ID
      The list of values data artifact resource ID of a data selection filter bind parameter attribute.
    • 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.
    • Title: List of Values Finder Name
      Maximum Length: 900
      The list of values finder of a data selection filter bind parameter attribute.
    • 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.
    • Title: List of Values Field
      Maximum Length: 900
      The field name of the list of values resource associated with this attribute.
    • 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.
    • 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.
    Back to Top