Jump to

• Request
• Response

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:
  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 Top

Response

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.

Body ()

Root Schema : dataGetterQueries-dataGetterQueryVersions-item-response

Type: object

Show Source

• 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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "dataGetterQueryElements":{
            "title":"Data Selection Tool Query Elements",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/dataGetterQueries-dataGetterQueryVersions-dataGetterQueryElements-item-response"
            }
        },
        "VersionDescription":{
            "title":"Version Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of a query version definition.",
            "nullable":true,
            "x-queryable":true
        },
        "Query":{
            "title":"Query",
            "type":"string",
            "description":"Data selection tool query object. This can be JSON or XML or a direct SQL query.",
            "format":"byte",
            "nullable":false,
            "x-queryable":true
        },
        "QueryStatusCode":{
            "title":"Query Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of a query version definition.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "QueryStatusMeaning":{
            "title":"Status Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the current query version status code. A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "VersionName":{
            "title":"Version Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a query version definition.",
            "nullable":false,
            "x-queryable":true
        },
        "QueryVersionId":{
            "title":"Query Version ID",
            "type":"integer",
            "description":"The unique identifier of a query version definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "VersionNumber":{
            "title":"Version Number",
            "type":"integer",
            "description":"The version number of the query definition.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        }
    }
}

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

• Array of: object dataGetterQueries-dataGetterQueryVersions-dataGetterQueryElements-item-response

{
    "title":"Data Selection Tool Query Elements",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/dataGetterQueries-dataGetterQueryVersions-dataGetterQueryElements-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : dataGetterQueries-dataGetterQueryVersions-dataGetterQueryElements-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "QueryElementId":{
            "title":"Query Element ID",
            "type":"integer",
            "description":"Data selection query and artifact element mapping unique identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ElementCode":{
            "title":"Element Code",
            "maxLength":"50",
            "type":"string",
            "description":"Artifact element code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ArtifactId":{
            "title":"Artifact ID",
            "type":"integer",
            "description":"Data resource unique identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "ElementName":{
            "title":"Element Name",
            "maxLength":"50",
            "type":"string",
            "description":"Name of a data artifact element.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ArtifactName":{
            "title":"Artifact Name",
            "maxLength":"50",
            "type":"string",
            "description":"Name of a data resource.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ElementId":{
            "title":"Element ID",
            "type":"integer",
            "description":"Artifact element unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

QueryStatusCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

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

dataGetterQueryElements

Operation: /fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}/child/dataGetterQueryVersions/{QueryVersionId}/child/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.

Back to Top