Skip to main content
POST
Get Data For Connection

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

connectionId
string
required

Body

application/json
tableId
string
required

The identifier of the table to retrieve data from.

Minimum string length: 1
engagementId
string
required

Identifies the engagement that the resulting Data Table will be associated with.

tabularSchemaHint
Tabular Schema · object

Optional schema hint describing expected column types.

filter
object

Optional filter to apply to the data retrieval.

limit
integer<int64>

Maximum number of rows to return.

Required range: x >= 0
offset
integer<int64>

Number of rows to skip before returning results.

Required range: x >= 0
sortProperties
Sort Property · object[]

Optional sort specification ordered by precedence. Remotes that support server-side sorting will apply it; remotes that don't will ignore it.

Response

202 - application/json

Accepted

id
string

The unique object identifier.

version
integer<int64>

Indicates the data integrity version to ensure data consistency.

creationDate
string<date-time>

The date that the object was originally created.

lastModifiedDate
string<date-time>

The date that the object was last updated or modified.

createdUserInfo
User Info · object
read-only

Details about the user who created the object.

lastModifiedUserInfo
User Info · object
read-only

Details about the user who last modified or updated the object.

type
enum<string>

Indicates the type of job being run.

Available options:
ANALYSIS_RUN,
ANALYSIS_SOURCE_INGESTION,
ADMIN_REPORT,
DATA_TABLE_EXPORT,
ANALYSIS_ROLL_FORWARD,
GDPDU_UNPACK_JOB,
ACCOUNT_GROUPING_EXPORT,
ACCOUNT_MAPPING_EXPORT,
DATA_TRANSFORMATION_JOB,
CONNECTION_TEST,
CONNECTION_TABLES,
DATA_TABLE,
DATA_SOURCE_IMPORT,
FILE_MANAGER_TO_DATA_TABLE
status
enum<string>

Indicates the current state of the job.

Available options:
IN_PROGRESS,
COMPLETE,
ERROR
entityId
string

Identifies the entity used in the job.

entityType
enum<string>

Identifies the entity type used in the job.

Available options:
ORGANIZATION,
ENGAGEMENT,
ANALYSIS,
ANALYSIS_RESULT,
ANALYSIS_SOURCE,
FILE_RESULT,
GDPDU_UNPACK_JOB,
ACCOUNT_GROUPING,
ENGAGEMENT_ACCOUNT_GROUPING,
FILE_MANAGER_FILE,
CONNECTION_TEST_RESULT,
CONNECTION_TABLES_RESULT,
DATA_TABLE,
DATA_SOURCE_IMPORT_TASK
error
string

The reason why the async job failed.

errorMessage
string