Jump to

• Request
• Response

Execute query and get data

post

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

Request

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.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• dataFormatType: string
  Query result format type such as HIERARCHICAL or FLAT.
• queryId: number
  ID of a query to be executed.
• queryInputPayload: string
  The payload received by the query.
• queryPayload: string
  Query payload to be executed.
• queryVersionId: number
  ID of a query version to be run.
• rowCount: number
  Query row count.

{
    "type":"object",
    "properties":{
        "queryPayload":{
            "type":"string",
            "description":"Query payload to be executed.",
            "nullable":true
        },
        "queryVersionId":{
            "type":"number",
            "description":"ID of a query version to be run.",
            "nullable":true
        },
        "dataFormatType":{
            "type":"string",
            "description":"Query result format type such as HIERARCHICAL or FLAT.",
            "nullable":true
        },
        "queryInputPayload":{
            "type":"string",
            "description":"The payload received by the query.",
            "nullable":true
        },
        "rowCount":{
            "type":"number",
            "description":"Query row count.",
            "nullable":true
        },
        "queryId":{
            "type":"number",
            "description":"ID of a query to be executed.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  Query result in JSON format.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Query result in JSON format."
        }
    },
    "additionalProperties":false
}

Back to Top