Get a data selection query

get

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

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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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-item-response
Type: object
Show Source
  • Title: Consumer Code
    Read Only: true
    Maximum Length: 50
    Data selection tool consumer unique code, such as COMM, RULES, or ADMISSIONS.
  • Title: Consumer ID
    Data selection tool consumer unique identifier.
  • Title: Consumer Instance ID Value
    Data selection tool consumer instance ID.
  • Title: Consumer Name
    Maximum Length: 100
    Name of the data selection tool consumer, such as the Fee discount calculation process.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the query.
  • Title: Creation Date
    Read Only: true
    Date and time of the creation of the query.
  • 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.
  • 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.
  • Title: Description
    Maximum Length: 240
    Description of the data selection tool query.
  • Title: Last Updated Date
    Read Only: true
    Date and time of the last update of the query.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who last updated the query.
  • Links
  • Title: Query
    Data selection tool query object. This can be JSON or XML or a direct SQL query.
  • 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.
  • Title: Query ID
    Read Only: true
    Data selection tool query unique identifier.
  • Title: Query Name
    Maximum Length: 100
    Name of the data selection tool query, such as Student fee calculation query.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Selection Tool ID
    Data selection tool unique identifier.
  • Title: Selection Tool Name
    Maximum Length: 100
    Name of the data selection tool.
  • 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 : 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: object
Show Source
Nested Schema : dataGetterQueries-dataGetterSubQueryUsages-item-response
Type: object
Show Source
  • Links
  • Title: Subquery Code
    Read Only: true
    Maximum Length: 255
    Data selection tool subquery unique code.
  • Title: Subquery ID
    Read Only: true
    Data selection tool subquery unique identifier.
  • Title: Subquery Name
    Read Only: true
    Maximum Length: 255
    Name of the data selection tool subquery, such as Student fee calculation query.
Nested Schema : dataGetterQueries-queryTagAssignments-item-response
Type: object
Show Source
Back to Top