Jump to

• Request
• Response

Get all data selection queries

get

/fscmRestApi/resources/11.13.18.05/dataGetterQueries

Request

Query Parameters

• 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
• finder: string
  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
  
  

  • ConsumerAndQueryStatusFinder Finds all the data selection queries with the specified consumer code and query status codes.
    Finder Variables
    • ConsumerCode; string; Unique code of the data selection tool consumer.
    • QueryStatusCode; string; Comma separated values of data selection tool query status codes.
  • PrimaryKey Finds all data selection queries that match the primary key criteria specified.
    Finder Variables
    • QueryId; integer; Unique identifier for the data selection query.
• limit: integer
  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.
• 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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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:
  

  • ConsumerCode; string; Data selection tool consumer unique code, such as COMM, RULES, or ADMISSIONS.
  • ConsumerId; integer; Data selection tool consumer unique identifier.
  • ConsumerInstanceId; integer; Data selection tool consumer instance ID.
  • ConsumerName; string; Name of the data selection tool consumer, such as the Fee discount calculation process.
  • CreatedBy; string; User who created the query.
  • CreationDate; string; Date and time of the creation of the query.
  • Description; string; Description of the data selection tool query.
  • LastUpdateDate; string; Date and time of the last update of the query.
  • LastUpdatedBy; string; User who last updated the query.
  • Query; string; Data selection tool query object. This can be JSON or XML or a direct SQL query.
  • QueryCode; string; 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; Data selection tool query unique identifier.
  • QueryName; string; Name of the data selection tool query, such as Student fee calculation query.
  • QueryStatusCode; string; 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; 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.
  • QueryTypeCode; string; 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; 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; Data selection tool unique identifier.
  • SelectionToolName; string; Name of the data selection tool.
  • UseAsSubQueryFlag; boolean; Indicates if a data selection tool query can be used as a subquery.
• totalResults: boolean
  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

• 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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/dataGetterQueries-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object dataGetterQueries-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/dataGetterQueries-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-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the query.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QueryTypeCode":{
            "title":"Query Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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-dataGetterQueryElements-item-response"
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time of the creation of the query.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QueryCode":{
            "title":"Query Code",
            "maxLength":"50",
            "type":"string",
            "description":"Data selection tool query unique code. This is a global unique code that the application automatically generates, and is used for data migration purpose.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the query.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the data selection tool query.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"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.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "DataQuery"
                ]
            },
            "x-queryable":true
        },
        "ConsumerCode":{
            "title":"Consumer Code",
            "maxLength":"50",
            "type":"string",
            "description":"Data selection tool consumer unique code, such as COMM, RULES, or ADMISSIONS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QueryStatusCode":{
            "title":"Query Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Data selection tool query status code, such as ORA_HEY_PUBLISHED, ORA_HEY_UNPUBLISHED<br>or ORA_HEY_DRAFT.<br>A list of accepted values is defined in the lookup type ORA_HEY_QUERY_STATUS_CODE.",
            "nullable":false,
            "default":"ORA_HEY_DRAFT",
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "QueryId":{
            "title":"Query ID",
            "type":"integer",
            "description":"Data selection tool query 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
        },
        "ConsumerName":{
            "title":"Consumer Name",
            "maxLength":"100",
            "type":"string",
            "description":"Name of the data selection tool consumer, such as the Fee discount calculation process.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "dataGetterSubQueryUsages":{
            "title":"Data Selection Tool Subquery Usages",
            "type":"array",
            "description":"Use the data selection tool subquery usages resource to view subquery usage information of a main query in data selection tool.",
            "items":{
                "$ref":"#/components/schemas/dataGetterQueries-dataGetterSubQueryUsages-item-response"
            }
        },
        "QueryName":{
            "title":"Query Name",
            "maxLength":"100",
            "type":"string",
            "description":"Name of the data selection tool query, such as Student fee calculation query.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "QueryTypeMeaning":{
            "title":"Query Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of data selection query type code, such as Ad hoc usage or Transaction.<br>A list of accepted values is defined in the lookup type ORA_HEY_QUERY_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SelectionToolName":{
            "title":"Selection Tool Name",
            "maxLength":"100",
            "type":"string",
            "description":"Name of the data selection tool.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "queryTagAssignments":{
            "title":"Data Selection Tool Query Tag Assignments",
            "type":"array",
            "description":"Use the data selection tool query tag assignments resource to view, create, modify, or delete data selection tool query tag assignments.",
            "items":{
                "$ref":"#/components/schemas/dataGetterQueries-queryTagAssignments-item-response"
            }
        },
        "UseAsSubQueryFlag":{
            "title":"Use as Subquery Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if a data selection tool query can be used as a subquery.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "QueryStatusMeaning":{
            "title":"Query Status",
            "maxLength":"80",
            "type":"string",
            "description":"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 <br>type ORA_HEY_QUERY_STATUS_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsumerId":{
            "title":"Consumer ID",
            "type":"integer",
            "description":"Data selection tool consumer unique identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ConsumerInstanceId":{
            "title":"Consumer Instance ID Value",
            "type":"integer",
            "description":"Data selection tool consumer instance ID.",
            "nullable":true,
            "x-queryable":true
        },
        "SelectionToolId":{
            "title":"Selection Tool ID",
            "type":"integer",
            "description":"Data selection tool unique identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time of the last update of the query.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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-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-dataGetterQueryElements-item-response"
    }
}

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

• Array of: object dataGetterQueries-dataGetterSubQueryUsages-item-response

{
    "title":"Data Selection Tool Subquery Usages",
    "type":"array",
    "description":"Use the data selection tool subquery usages resource to view subquery usage information of a main query in data selection tool.",
    "items":{
        "$ref":"#/components/schemas/dataGetterQueries-dataGetterSubQueryUsages-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 : 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

• Array of: object dataGetterQueries-queryTagAssignments-item-response

{
    "title":"Data Selection Tool Query Tag Assignments",
    "type":"array",
    "description":"Use the data selection tool query tag assignments resource to view, create, modify, or delete data selection tool query tag assignments.",
    "items":{
        "$ref":"#/components/schemas/dataGetterQueries-queryTagAssignments-item-response"
    }
}

Nested Schema : dataGetterQueries-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

  Data selection query and artifact element mapping unique identifier.

{
    "type":"object",
    "properties":{
        "QueryElementId":{
            "title":"Query Element ID",
            "type":"integer",
            "description":"Data selection query and artifact element mapping unique identifier.",
            "format":"int64",
            "nullable":false,
            "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
        },
        "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."
        }
    }
}

Nested Schema : dataGetterQueries-dataGetterSubQueryUsages-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubQueryName":{
            "title":"Subquery Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the data selection tool subquery, such as Student fee calculation query.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubQueryId":{
            "title":"Subquery ID",
            "type":"integer",
            "description":"Data selection tool subquery unique identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubQueryCode":{
            "title":"Subquery Code",
            "maxLength":"255",
            "type":"string",
            "description":"Data selection tool subquery unique code.",
            "nullable":true,
            "readOnly":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 : dataGetterQueries-queryTagAssignments-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "TagId":{
            "title":"Tag ID",
            "type":"integer",
            "description":"The tag identifier of the data selection query tag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TagAssignmentId":{
            "title":"Tag Assignment ID",
            "type":"integer",
            "description":"The tag assignment identifier of the data selection query tag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TagCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The tag code of the data selection query tag.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TagName":{
            "maxLength":"64",
            "type":"string",
            "description":"The tag name of the data selection query tag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TagDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"The tag description of the data selection query tag.",
            "nullable":true,
            "readOnly":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"
    }
}

Links

getQueryData

Operation: /fscmRestApi/resources/11.13.18.05/dataGetterQueries/action/getQueryData

Accepts query ID, data format type, selection tool ID, query payload and returns a JSON string which contains the query result.

Back to Top