Oracle Primavera Cloud Data Service API

Query the data for a list of tables

post

/data/rest/dataservice/runquery

The result contains the data from specified tables with specified columns. Invalid columns is ignored. There are two extra sections in the result: pagination information and timestamp for next incremental query.

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : QueryObject

Type: object

Title: QueryObject

Show Source

name: string

An optional query name
nextKey: string

When there is more data on server, the result from last query returns nextKey property. The value comes from last query when there is more data on server.
nextTableName: string

When there is more data on server, the result from last query returns nextTableName property. A value "-1" indicates no more data on server. The value comes from last query when there is more data on server.
pageSize: string

Minimum Value: 1

Maximum Value: 10000

Specifies how many rows returned from this query
sinceDate: string

A database date that the query fetches rows created/updated after it. The value should either be null or returned from last query.
tables(required): array tables

A list of queries for tables

{
    "title":"QueryObject",
    "required":[
        "tables"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"An optional query name",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "tables":{
            "type":"array",
            "description":"A list of queries for tables",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/TableQuery",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "nextKey":{
            "type":"string",
            "description":"When there is more data on server, the result from last query returns nextKey property.\nThe value comes from last query when there is more data on server.\n",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "sinceDate":{
            "type":"string",
            "description":"A database date that the query fetches rows created/updated after it.\nThe value should either be null or returned from last query.\n",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "nextTableName":{
            "type":"string",
            "description":"When there is more data on server, the result from last query returns nextTableName property.\nA value \"-1\" indicates no more data on server.\nThe value comes from last query when there is more data on server.\n",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "pageSize":{
            "maximum":10000,
            "minimum":1,
            "type":"string",
            "description":"Specifies how many rows returned from this query",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : tables

Type: array

A list of queries for tables

Show Source

Array of: object TableQuery

Title: TableQuery

A list of queries for tables

{
    "type":"array",
    "description":"A list of queries for tables",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/TableQuery",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : TableQuery

Type: object

Title: TableQuery

A list of queries for tables

Show Source

columns(required): array columns

A comma separated list of columns of the query
condition: condition

The filter of the query
joinCondition: joinCondition

Joined tables
joinedTables: array joinedTables

Joined tables
tableName(required): string

The from table name of the query

{
    "title":"TableQuery",
    "required":[
        "columns",
        "tableName"
    ],
    "type":"object",
    "properties":{
        "columns":{
            "type":"array",
            "description":"A comma separated list of columns of the query",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "description":"A comma separated list of columns of the query",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "tableName":{
            "type":"string",
            "description":"The from table name of the query",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "condition":{
            "description":"The filter of the query",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/Condition"
                }
            ]
        },
        "joinedTables":{
            "type":"array",
            "description":"Joined tables",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/TableQuery",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "joinCondition":{
            "description":"Joined tables",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/JoinCondition"
                }
            ]
        }
    },
    "description":"A list of queries for tables",
    "exampleSetFlag":false
}

Nested Schema : columns

Type: array

A comma separated list of columns of the query

Show Source

Array of: string

A comma separated list of columns of the query

{
    "type":"array",
    "description":"A comma separated list of columns of the query",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "description":"A comma separated list of columns of the query",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

Nested Schema : condition

The filter of the query

Match All

The filter of the query

Show Source

object Condition

Title: Condition

The criteria of the query

{
    "description":"The filter of the query",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/Condition"
        }
    ]
}

Nested Schema : joinCondition

Joined tables

Match All

Joined tables

Show Source

object JoinCondition

Title: JoinCondition

Joined tables

{
    "description":"Joined tables",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/JoinCondition"
        }
    ]
}

Nested Schema : joinedTables

Type: array

Joined tables

Show Source

Array of: object TableQuery

Title: TableQuery

A list of queries for tables

{
    "type":"array",
    "description":"Joined tables",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/TableQuery",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : Condition

Type: object

Title: Condition

The criteria of the query

Show Source

columnName: string

The column name. This property is ignored when the operator is AND/OR.
conditions: array conditions

List of Conditions if the operator is AND/OR.
operator: string

Allowed Values: [ "AND", "OR", "IS_NULL", "IS_NOT_NULL", "EQUALS", "NOT_EQUALS", "GREATER_THAN", "LESS_THAN", "GREATER_THAN_OR_EQUALS", "LESS_THAN_OR_EQUALS", "BETWEEN" ]

The condition operator
value1: string

The first value of the criteria. When the operator is AND/OR/IS_NULL/IS_NOT_NULL, this property is ignored.
value2: string

The second value of the criteria. This property is used only when the operator is BETWEEN.

{
    "title":"Condition",
    "type":"object",
    "properties":{
        "value1":{
            "type":"string",
            "description":"The first value of the criteria. When the operator is AND/OR/IS_NULL/IS_NOT_NULL, this property is ignored.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "value2":{
            "type":"string",
            "description":"The second value of the criteria. This property is used only when the operator is BETWEEN.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnName":{
            "type":"string",
            "description":"The column name. This property is ignored when the operator is AND/OR.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "operator":{
            "type":"string",
            "description":"The condition operator",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "AND",
                "OR",
                "IS_NULL",
                "IS_NOT_NULL",
                "EQUALS",
                "NOT_EQUALS",
                "GREATER_THAN",
                "LESS_THAN",
                "GREATER_THAN_OR_EQUALS",
                "LESS_THAN_OR_EQUALS",
                "BETWEEN"
            ]
        },
        "conditions":{
            "type":"array",
            "description":"List of Conditions if the operator is AND/OR.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/Condition",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        }
    },
    "description":"The criteria of the query",
    "exampleSetFlag":false
}

Nested Schema : conditions

Type: array

List of Conditions if the operator is AND/OR.

Show Source

Array of: object Condition

Title: Condition

The criteria of the query

{
    "type":"array",
    "description":"List of Conditions if the operator is AND/OR.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/Condition",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : JoinCondition

Type: object

Title: JoinCondition

Joined tables

Show Source

joinColumn: string

The column name from joined table
parentTableColumn: string

The column name of parent table

{
    "title":"JoinCondition",
    "type":"object",
    "properties":{
        "parentTableColumn":{
            "type":"string",
            "description":"The column name of parent table",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "joinColumn":{
            "type":"string",
            "description":"The column name from joined table",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"Joined tables",
    "exampleSetFlag":false
}

Examples

Response

Supported Media Types

application/json

200 Response

API success

Root Schema : DataObject

Type: object

Title: DataObject

Show Source

data: object data

Additional Properties Allowed: additionalProperties

A list of tables, which contains rows of column data. It also returns a database date for next query to retrieve fresh data only. If next query only cares about the data being created/updated after current query, it would supply sinceDate property from current query in the next query. A pagination section is also returned in the response to indicate if there is more data on the server. When nextTableName="-1", no more data available. The next query should use original query PLUS pagination information to retrieve the remaining data on server.

{
    "title":"DataObject",
    "type":"object",
    "properties":{
        "data":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "description":"A list of tables, which contains rows of column data.\nIt also returns a database date for next query to retrieve fresh data only.\nIf next query only cares about the data being created/updated after current query, it would supply sinceDate property from current query in the next query.\nA pagination section is also returned in the response to indicate if there is more data on the server.\nWhen nextTableName=\"-1\", no more data available.\nThe next query should use original query PLUS pagination information to retrieve the remaining data on server.\n",
                "exampleSetFlag":false,
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string",
                        "description":"A list of tables, which contains rows of column data.\nIt also returns a database date for next query to retrieve fresh data only.\nIf next query only cares about the data being created/updated after current query, it would supply sinceDate property from current query in the next query.\nA pagination section is also returned in the response to indicate if there is more data on the server.\nWhen nextTableName=\"-1\", no more data available.\nThe next query should use original query PLUS pagination information to retrieve the remaining data on server.\n",
                        "exampleSetFlag":false,
                        "types":[
                            "string"
                        ]
                    },
                    "description":"A list of tables, which contains rows of column data.\nIt also returns a database date for next query to retrieve fresh data only.\nIf next query only cares about the data being created/updated after current query, it would supply sinceDate property from current query in the next query.\nA pagination section is also returned in the response to indicate if there is more data on the server.\nWhen nextTableName=\"-1\", no more data available.\nThe next query should use original query PLUS pagination information to retrieve the remaining data on server.\n",
                    "exampleSetFlag":false,
                    "types":[
                        "object"
                    ],
                    "jsonSchema":{
                        "type":"object",
                        "description":"A list of tables, which contains rows of column data.\nIt also returns a database date for next query to retrieve fresh data only.\nIf next query only cares about the data being created/updated after current query, it would supply sinceDate property from current query in the next query.\nA pagination section is also returned in the response to indicate if there is more data on the server.\nWhen nextTableName=\"-1\", no more data available.\nThe next query should use original query PLUS pagination information to retrieve the remaining data on server.\n"
                    }
                },
                "types":[
                    "array"
                ]
            },
            "description":"A list of tables, which contains rows of column data.\nIt also returns a database date for next query to retrieve fresh data only.\nIf next query only cares about the data being created/updated after current query, it would supply sinceDate property from current query in the next query.\nA pagination section is also returned in the response to indicate if there is more data on the server.\nWhen nextTableName=\"-1\", no more data available.\nThe next query should use original query PLUS pagination information to retrieve the remaining data on server.\n",
            "exampleSetFlag":false,
            "types":[
                "object"
            ],
            "jsonSchema":{
                "type":"object",
                "description":"A list of tables, which contains rows of column data.\nIt also returns a database date for next query to retrieve fresh data only.\nIf next query only cares about the data being created/updated after current query, it would supply sinceDate property from current query in the next query.\nA pagination section is also returned in the response to indicate if there is more data on the server.\nWhen nextTableName=\"-1\", no more data available.\nThe next query should use original query PLUS pagination information to retrieve the remaining data on server.\n"
            }
        }
    },
    "exampleSetFlag":false
}

Nested Schema : data

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

A list of tables, which contains rows of column data. It also returns a database date for next query to retrieve fresh data only. If next query only cares about the data being created/updated after current query, it would supply sinceDate property from current query in the next query. A pagination section is also returned in the response to indicate if there is more data on the server. When nextTableName="-1", no more data available. The next query should use original query PLUS pagination information to retrieve the remaining data on server.

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "description":"A list of tables, which contains rows of column data.\nIt also returns a database date for next query to retrieve fresh data only.\nIf next query only cares about the data being created/updated after current query, it would supply sinceDate property from current query in the next query.\nA pagination section is also returned in the response to indicate if there is more data on the server.\nWhen nextTableName=\"-1\", no more data available.\nThe next query should use original query PLUS pagination information to retrieve the remaining data on server.\n",
        "exampleSetFlag":false,
        "items":{
            "type":"object",
            "additionalProperties":{
                "type":"string",
                "description":"A list of tables, which contains rows of column data.\nIt also returns a database date for next query to retrieve fresh data only.\nIf next query only cares about the data being created/updated after current query, it would supply sinceDate property from current query in the next query.\nA pagination section is also returned in the response to indicate if there is more data on the server.\nWhen nextTableName=\"-1\", no more data available.\nThe next query should use original query PLUS pagination information to retrieve the remaining data on server.\n",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "description":"A list of tables, which contains rows of column data.\nIt also returns a database date for next query to retrieve fresh data only.\nIf next query only cares about the data being created/updated after current query, it would supply sinceDate property from current query in the next query.\nA pagination section is also returned in the response to indicate if there is more data on the server.\nWhen nextTableName=\"-1\", no more data available.\nThe next query should use original query PLUS pagination information to retrieve the remaining data on server.\n",
            "exampleSetFlag":false,
            "types":[
                "object"
            ],
            "jsonSchema":{
                "type":"object",
                "description":"A list of tables, which contains rows of column data.\nIt also returns a database date for next query to retrieve fresh data only.\nIf next query only cares about the data being created/updated after current query, it would supply sinceDate property from current query in the next query.\nA pagination section is also returned in the response to indicate if there is more data on the server.\nWhen nextTableName=\"-1\", no more data available.\nThe next query should use original query PLUS pagination information to retrieve the remaining data on server.\n"
            }
        },
        "types":[
            "array"
        ]
    },
    "description":"A list of tables, which contains rows of column data.\nIt also returns a database date for next query to retrieve fresh data only.\nIf next query only cares about the data being created/updated after current query, it would supply sinceDate property from current query in the next query.\nA pagination section is also returned in the response to indicate if there is more data on the server.\nWhen nextTableName=\"-1\", no more data available.\nThe next query should use original query PLUS pagination information to retrieve the remaining data on server.\n",
    "exampleSetFlag":false,
    "types":[
        "object"
    ],
    "jsonSchema":{
        "type":"object",
        "description":"A list of tables, which contains rows of column data.\nIt also returns a database date for next query to retrieve fresh data only.\nIf next query only cares about the data being created/updated after current query, it would supply sinceDate property from current query in the next query.\nA pagination section is also returned in the response to indicate if there is more data on the server.\nWhen nextTableName=\"-1\", no more data available.\nThe next query should use original query PLUS pagination information to retrieve the remaining data on server.\n"
    }
}

A list of tables, which contains rows of column data. It also returns a database date for next query to retrieve fresh data only. If next query only cares about the data being created/updated after current query, it would supply sinceDate property from current query in the next query. A pagination section is also returned in the response to indicate if there is more data on the server. When nextTableName="-1", no more data available. The next query should use original query PLUS pagination information to retrieve the remaining data on server.

Nested Schema : additionalProperties

Type: array

Show Source

Array of: object items

Additional Properties Allowed: additionalProperties

A list of tables, which contains rows of column data. It also returns a database date for next query to retrieve fresh data only. If next query only cares about the data being created/updated after current query, it would supply sinceDate property from current query in the next query. A pagination section is also returned in the response to indicate if there is more data on the server. When nextTableName="-1", no more data available. The next query should use original query PLUS pagination information to retrieve the remaining data on server.

{
    "type":"array",
    "description":"A list of tables, which contains rows of column data.\nIt also returns a database date for next query to retrieve fresh data only.\nIf next query only cares about the data being created/updated after current query, it would supply sinceDate property from current query in the next query.\nA pagination section is also returned in the response to indicate if there is more data on the server.\nWhen nextTableName=\"-1\", no more data available.\nThe next query should use original query PLUS pagination information to retrieve the remaining data on server.\n",
    "exampleSetFlag":false,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string",
            "description":"A list of tables, which contains rows of column data.\nIt also returns a database date for next query to retrieve fresh data only.\nIf next query only cares about the data being created/updated after current query, it would supply sinceDate property from current query in the next query.\nA pagination section is also returned in the response to indicate if there is more data on the server.\nWhen nextTableName=\"-1\", no more data available.\nThe next query should use original query PLUS pagination information to retrieve the remaining data on server.\n",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "description":"A list of tables, which contains rows of column data.\nIt also returns a database date for next query to retrieve fresh data only.\nIf next query only cares about the data being created/updated after current query, it would supply sinceDate property from current query in the next query.\nA pagination section is also returned in the response to indicate if there is more data on the server.\nWhen nextTableName=\"-1\", no more data available.\nThe next query should use original query PLUS pagination information to retrieve the remaining data on server.\n",
        "exampleSetFlag":false,
        "types":[
            "object"
        ],
        "jsonSchema":{
            "type":"object",
            "description":"A list of tables, which contains rows of column data.\nIt also returns a database date for next query to retrieve fresh data only.\nIf next query only cares about the data being created/updated after current query, it would supply sinceDate property from current query in the next query.\nA pagination section is also returned in the response to indicate if there is more data on the server.\nWhen nextTableName=\"-1\", no more data available.\nThe next query should use original query PLUS pagination information to retrieve the remaining data on server.\n"
        }
    },
    "types":[
        "array"
    ]
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

string

A list of tables, which contains rows of column data. It also returns a database date for next query to retrieve fresh data only. If next query only cares about the data being created/updated after current query, it would supply sinceDate property from current query in the next query. A pagination section is also returned in the response to indicate if there is more data on the server. When nextTableName="-1", no more data available. The next query should use original query PLUS pagination information to retrieve the remaining data on server.

{
    "type":"object",
    "additionalProperties":{
        "type":"string",
        "description":"A list of tables, which contains rows of column data.\nIt also returns a database date for next query to retrieve fresh data only.\nIf next query only cares about the data being created/updated after current query, it would supply sinceDate property from current query in the next query.\nA pagination section is also returned in the response to indicate if there is more data on the server.\nWhen nextTableName=\"-1\", no more data available.\nThe next query should use original query PLUS pagination information to retrieve the remaining data on server.\n",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "description":"A list of tables, which contains rows of column data.\nIt also returns a database date for next query to retrieve fresh data only.\nIf next query only cares about the data being created/updated after current query, it would supply sinceDate property from current query in the next query.\nA pagination section is also returned in the response to indicate if there is more data on the server.\nWhen nextTableName=\"-1\", no more data available.\nThe next query should use original query PLUS pagination information to retrieve the remaining data on server.\n",
    "exampleSetFlag":false,
    "types":[
        "object"
    ],
    "jsonSchema":{
        "type":"object",
        "description":"A list of tables, which contains rows of column data.\nIt also returns a database date for next query to retrieve fresh data only.\nIf next query only cares about the data being created/updated after current query, it would supply sinceDate property from current query in the next query.\nA pagination section is also returned in the response to indicate if there is more data on the server.\nWhen nextTableName=\"-1\", no more data available.\nThe next query should use original query PLUS pagination information to retrieve the remaining data on server.\n"
    }
}

403 Response

You do not have access to the resource.

404 Response

Invalid query