View Supported Tables and Columns

The Primavera Data Service provides endpoints that return a list of currently supported database tables and columns. You should send a request to these endpoints to discover the types of application data you can retrieve using the data service. Each database table or column returned by the data service stores a particular piece of application data. For example, the TASK table stores columns that contain activity data, such as TASK_NAME and TASK_TYPE. If you want to use the data service to extract activity names and types from the application, you can specify the TASK table and the TASK_NAME and TASK_TYPE columns in your request body to the runquery endpoint.

The following data service endpoints return responses that list supported tables or columns. These requests use the GET method. You should send requests to these endpoints periodically to determine what application data is accessible.

https://<url>/sync/rest-service/dataservice/metadata/tables?configCode=<Configuration name>
https://<url>/sync/rest-service/dataservice/metadata/columns/<tableName>?configCode=<configuration name>
https://<url>/sync/rest-service/dataservice/metadata/refresh?configCode=<Configuration name>

The variables in the previous examples should be replaced with the following information:

  • <url>: The URL provided to you when the application was deployed.
  • <tableName>: The name of a database table listed in the response of the tables endpoint. For example, TASK. This value is case insensitive.
  • <configuration name>: The name of the configuration you want to access.