Jump to

• Request
• Response

Create a data selection query version

post

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

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=

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Query(required): string (byte)
  Title: Query

  Data selection tool query object. This can be JSON or XML or a direct SQL query.
• queryBusinessObjects: array Query Business Objects
  Title: Query Business Objects

  Query business objects resource is used to view, create, modify, or delete query business objects in 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(required): string
  Title: Query Status Code

  Maximum Length: 30

  The status code of a query version definition.
• 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(required): string
  Title: Version Name

  Maximum Length: 50

  The name of a query version definition.

{
    "required":[
        "Query",
        "QueryStatusCode",
        "VersionName"
    ],
    "type":"object",
    "properties":{
        "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
        },
        "QueryStatusCode":{
            "title":"Query Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status code of a query version definition.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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"
            }
        },
        "VersionDescription":{
            "title":"Version Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of a query version definition.",
            "nullable":true
        },
        "VersionName":{
            "title":"Version Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a query version definition.",
            "nullable":false
        },
        "queryBusinessObjects":{
            "title":"Query Business Objects",
            "type":"array",
            "description":"Query business objects resource is used to view, create, modify, or delete query business objects in query.",
            "items":{
                "$ref":"#/components/schemas/dataGetterQueries-dataGetterQueryVersions-queryBusinessObjects-item-post-request"
            }
        },
        "queryFilterParameters":{
            "title":"Query Filter Parameters",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/dataGetterQueries-dataGetterQueryVersions-queryFilterParameters-item-post-request"
            }
        }
    }
}

Nested Schema : Query Business Objects

Type: array

Title: Query Business Objects

Query business objects resource is used to view, create, modify, or delete query business objects in query.

Show Source

• Array of: object schema

{
    "title":"Query Business Objects",
    "type":"array",
    "description":"Query business objects resource is used to view, create, modify, or delete query business objects in query.",
    "items":{
        "$ref":"#/components/schemas/dataGetterQueries-dataGetterQueryVersions-queryBusinessObjects-item-post-request"
    }
}

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

• Array of: object dataGetterQueries-dataGetterQueryVersions-queryFilterParameters-item-post-request

{
    "title":"Query Filter Parameters",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/dataGetterQueries-dataGetterQueryVersions-queryFilterParameters-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• BusinessObjectCode: string
  Title: Query Business Object Code

  Maximum Length: 50

  The code of a business object that's associated with a query.
• 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":{
        "BusinessObjectCode":{
            "title":"Query Business Object Code",
            "maxLength":50,
            "type":"string",
            "description":"The code of a business object that's associated with a query.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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
        }
    }
}

Nested Schema : dataGetterQueries-dataGetterQueryVersions-queryFilterParameters-item-post-request

Type: object

Show Source

• 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.
• 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.
• FilterParamDescription: string
  Title: Filter Parameter Description

  Maximum Length: 240

  The description 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.
• 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.
• LovSourceResourceName: 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.

{
    "type":"object",
    "properties":{
        "DefaultValue":{
            "title":"Default Value",
            "maxLength":512,
            "type":"string",
            "description":"The default value of a data selection filter bind parameter attribute.",
            "nullable":true
        },
        "DefaultValueJson":{
            "title":"Default Value JSON Format",
            "type":"string",
            "description":"Default value of the attribute in JSON format. Used by list variables.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "FilterParamDataTypeCode":{
            "title":"Filter Parameter Data Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FilterParamDescription":{
            "title":"Filter Parameter Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of a data selection filter bind parameter.",
            "nullable":true
        },
        "FilterParamName":{
            "title":"Filter Parameter Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of a data selection filter bind parameter.",
            "nullable":false
        },
        "FilterParamTypeCode":{
            "title":"Filter Parameter Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LookupTypeCode":{
            "title":"List of Values Lookup Type",
            "maxLength":30,
            "type":"string",
            "description":"The list of values lookup type of a data selection filter bind parameter attribute.",
            "nullable":true
        },
        "LovArtifactId":{
            "title":"List of Values ID",
            "type":"integer",
            "description":"The list of values data artifact resource ID of a data selection filter bind parameter attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "LovDisplayFields":{
            "title":"List of Values Display Fields",
            "maxLength":900,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "LovFinder":{
            "title":"List of Values Finder Name",
            "maxLength":900,
            "type":"string",
            "description":"The list of values finder of a data selection filter bind parameter attribute.",
            "nullable":true
        },
        "LovSourceResourceName":{
            "title":"List of Values Source Resource Name",
            "maxLength":200,
            "type":"string",
            "description":"The source resource name for the list of values resource of a data selection filter bind parameter attribute.",
            "nullable":true
        },
        "LovValueField":{
            "title":"List of Values Field",
            "maxLength":900,
            "type":"string",
            "description":"The field name of the list of values resource associated with this attribute.",
            "nullable":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
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false
        }
    }
}

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

• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the query version was created.
• 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.
• queryBusinessObjects: array Query Business Objects
  Title: Query Business Objects

  Query business objects resource is used to view, create, modify, or delete query business objects in 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the query version was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the query version was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The person who updated the query version.",
            "nullable":false,
            "readOnly":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
        },
        "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
        },
        "VersionDescription":{
            "title":"Version Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of a query version definition.",
            "nullable":true,
            "x-queryable":true
        },
        "VersionName":{
            "title":"Version Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a query version definition.",
            "nullable":false,
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "queryBusinessObjects":{
            "title":"Query Business Objects",
            "type":"array",
            "description":"Query business objects resource is used to view, create, modify, or delete query business objects in query.",
            "items":{
                "$ref":"#/components/schemas/dataGetterQueries-dataGetterQueryVersions-queryBusinessObjects-item-response"
            }
        },
        "queryFilterParameters":{
            "title":"Query Filter Parameters",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/dataGetterQueries-dataGetterQueryVersions-queryFilterParameters-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 : Query Business Objects

Type: array

Title: Query Business Objects

Query business objects resource is used to view, create, modify, or delete query business objects in query.

Show Source

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

{
    "title":"Query Business Objects",
    "type":"array",
    "description":"Query business objects resource is used to view, create, modify, or delete query business objects in query.",
    "items":{
        "$ref":"#/components/schemas/dataGetterQueries-dataGetterQueryVersions-queryBusinessObjects-item-response"
    }
}

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

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

{
    "title":"Query Filter Parameters",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/dataGetterQueries-dataGetterQueryVersions-queryFilterParameters-item-response"
    }
}

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-dataGetterQueryVersions-queryBusinessObjects-item-response

Type: object

Show Source

• BusinessObjectCode: string
  Title: Query Business Object Code

  Maximum Length: 50

  The code of a business object that's associated with a query.
• BusinessObjectName: string
  Title: Query Business Object Name

  Read Only: true

  Maximum Length: 100

  The display string for the business object that's associated with a query.
• Description: string
  Title: Query Business Object Description

  Read Only: true

  Maximum Length: 255

  The description string for the business object that's associated with a query.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• QueryBusinessObjectId: integer (int64)
  Title: Query Business Object ID

  Read Only: true

  The unique identifier of the query business object.
• 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":{
        "BusinessObjectCode":{
            "title":"Query Business Object Code",
            "maxLength":50,
            "type":"string",
            "description":"The code of a business object that's associated with a query.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BusinessObjectName":{
            "title":"Query Business Object Name",
            "maxLength":100,
            "type":"string",
            "description":"The display string for the business object that's associated with a query.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Query Business Object Description",
            "maxLength":255,
            "type":"string",
            "description":"The description string for the business object that's associated with a query.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QueryBusinessObjectId":{
            "title":"Query Business Object ID",
            "type":"integer",
            "description":"The unique identifier of the query business object.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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-queryFilterParameters-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "ArtifactCode":{
            "title":"Artifact Code",
            "maxLength":50,
            "type":"string",
            "description":"The unique code of the list of values data artifact resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ArtifactName":{
            "title":"Artifact Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the list of values data artifact resource.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DefaultValue":{
            "title":"Default Value",
            "maxLength":512,
            "type":"string",
            "description":"The default value of a data selection filter bind parameter attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultValueJson":{
            "title":"Default Value JSON Format",
            "type":"string",
            "description":"Default value of the attribute in JSON format. Used by list variables.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "FilterParamCode":{
            "title":"Filter Parameter Code",
            "maxLength":50,
            "type":"string",
            "description":"The data selection filter bind parameter unique code, such as UNIT_GRADE.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_HEY_SINGLE_VARIABLE",
            "x-queryable":true
        },
        "FilterParamDataTypeCode":{
            "title":"Filter Parameter Data Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FilterParamDataTypeMeaning":{
            "title":"Filter Parameter Data Type",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FilterParamDescription":{
            "title":"Filter Parameter Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of a data selection filter bind parameter.",
            "nullable":true,
            "x-queryable":true
        },
        "FilterParamId":{
            "title":"Filter Parameter ID",
            "type":"integer",
            "description":"The unique identifier of a data selection filter bind parameter.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FilterParamName":{
            "title":"Filter Parameter Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of a data selection filter bind parameter.",
            "nullable":false,
            "x-queryable":true
        },
        "FilterParamTypeCode":{
            "title":"Filter Parameter Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FilterParamTypeMeaning":{
            "title":"Filter Parameter Type",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupTypeCode":{
            "title":"List of Values Lookup Type",
            "maxLength":30,
            "type":"string",
            "description":"The list of values lookup type of a data selection filter bind parameter attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LovArtifactId":{
            "title":"List of Values ID",
            "type":"integer",
            "description":"The list of values data artifact resource ID of a data selection filter bind parameter attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LovDisplayFields":{
            "title":"List of Values Display Fields",
            "maxLength":900,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "LovFinder":{
            "title":"List of Values Finder Name",
            "maxLength":900,
            "type":"string",
            "description":"The list of values finder of a data selection filter bind parameter attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LovSourceResourceName":{
            "title":"List of Values Source Resource Name",
            "maxLength":200,
            "type":"string",
            "description":"The source resource name for the list of values resource of a data selection filter bind parameter attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LovValueField":{
            "title":"List of Values Field",
            "maxLength":900,
            "type":"string",
            "description":"The field name of the list of values resource associated with this attribute.",
            "nullable":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
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

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

queryBusinessObjects

Operation: /fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}/child/dataGetterQueryVersions/{QueryVersionId}/child/queryBusinessObjects

Parameters:

• QueryId: $request.path.QueryId
• QueryVersionId: $request.path.QueryVersionId

Query business objects resource is used to view, create, modify, or delete query business objects in query.

queryFilterParameters

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

Back to Top