Jump to

• Request
• Response

Create a data selection query

post

/fscmRestApi/resources/11.13.18.05/dataGetterQueries

Request

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.
• Upsert-Mode:
  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

• 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.
• 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.
• 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.
• QueryName(required): 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.
• 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(required): 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.
• 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.

{
    "required":[
        "QueryName",
        "QueryTypeCode"
    ],
    "type":"object",
    "properties":{
        "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"
            }
        },
        "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-post-request"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
                ]
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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-post-request"
            }
        },
        "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"
            }
        },
        "SelectionToolName":{
            "title":"Selection Tool Name",
            "maxLength":100,
            "type":"string",
            "description":"Name of the data selection tool.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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-post-request"
            }
        },
        "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"
            }
        },
        "ConsumerId":{
            "title":"Consumer ID",
            "type":"integer",
            "description":"Data selection tool consumer unique identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ConsumerInstanceId":{
            "title":"Consumer Instance ID Value",
            "type":"integer",
            "description":"Data selection tool consumer instance ID.",
            "nullable":true
        },
        "SelectionToolId":{
            "title":"Selection Tool ID",
            "type":"integer",
            "description":"Data selection tool unique identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 schema

{
    "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-post-request"
    }
}

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-post-request

{
    "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-post-request"
    }
}

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 schema

{
    "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-post-request"
    }
}

Nested Schema : schema

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.
• ElementId: integer (int64)
  Title: Element ID

  Artifact element unique identifier.
• ElementName: string
  Title: Element Name

  Maximum Length: 50

  Name of a data artifact element.
• QueryElementId: integer (int64)
  Title: Query Element ID

  Data selection query and artifact element mapping unique identifier.

{
    "type":"object",
    "properties":{
        "ArtifactName":{
            "title":"Artifact Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of a data resource.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "ElementName":{
            "title":"Element Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of a data artifact element.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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"
            }
        }
    }
}

Nested Schema : dataGetterQueries-dataGetterSubQueryUsages-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.
• TagId: integer (int64)
  Title: Tag ID

  The tag identifier 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
            }
        },
        "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"
            }
        },
        "TagCode":{
            "maxLength":30,
            "type":"string",
            "description":"The tag code of the data selection query tag.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : dataGetterQueries-item-response

Type: object

Show Source

• 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

dataGetterConsumersLOV

Operation: /fscmRestApi/resources/11.13.18.05/dataGetterConsumers

The following properties are defined on the LOV link relation:

• Source Attribute: ConsumerName; Target Attribute: ConsumerName
• Display Attribute: ConsumerName

dataGetterQueryElements

Operation: /fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}/child/dataGetterQueryElements

Parameters:

• QueryId: $request.path.QueryId

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.

dataGetterSelectionToolsLOV

Operation: /fscmRestApi/resources/11.13.18.05/dataGetterSelectionTools

The following properties are defined on the LOV link relation:

• Source Attribute: SelectionToolName; Target Attribute: SelectionToolId
• Display Attribute: SelectionToolName

dataGetterSubQueryUsages

Operation: /fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}/child/dataGetterSubQueryUsages

Parameters:

• QueryId: $request.path.QueryId

Use the data selection tool subquery usages resource to view subquery usage information of a main query in data selection tool.

heyLookupsLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HEY_QUERY_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: QueryTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

heyLookupsStatusLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HEY_QUERY_STATUS_CODE

The following properties are defined on the LOV link relation:

• Source Attribute: QueryStatusCode; Target Attribute: LookupCode
• Display Attribute: Meaning

queryTagAssignments

Operation: /fscmRestApi/resources/11.13.18.05/dataGetterQueries/{QueryId}/child/queryTagAssignments

Parameters:

• QueryId: $request.path.QueryId

Use the data selection tool query tag assignments resource to view, create, modify, or delete data selection tool query tag assignments.

Back to Top