Data Pool

Index

get

Pagination

Pagination is available for this request. Please see the section on using pagination for more details.

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

  • name

  • name_count

  • nameExists

  • description

  • description_count

  • descriptionExists

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

  • name

Available Fields

These are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.

  • data_pools.id

  • data_pools.name

  • data_pools.description

  • data_pools.data_pool_template_id

  • data_pools.created_at

  • data_pools.updated_at

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

  • created_at

Authorizations
Query parameters
filter[name]stringOptional

Filter results by name.

filter[id]stringOptional

Filter results by id.

filter[,]stringOptional

Filter results by ,.

includestringOptional

Comma-separated list of relationships to include. Available: name, description

sortstringOptional

Sort field. Prefix with - for descending. Available: created_at

pageinteger · min: 1Optional

Page number for pagination.

Default: 1
per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses
chevron-right
200

Successful response

application/json
get
/api/v1/data-pool

Store

post

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field
Type
Required

name

string

description

string

Authorizations
Body
descriptionstring · max: 255 · nullableOptional
namestring · min: 3 · max: 100Required
Responses
chevron-right
200

Successful response

application/json
post
/api/v1/data-pool

Show

get

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

  • name

  • name_count

  • nameExists

  • description

  • description_count

  • descriptionExists

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

  • name

Available Fields

These are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.

  • data_pools.id

  • data_pools.name

  • data_pools.description

  • data_pools.data_pool_template_id

  • data_pools.created_at

  • data_pools.updated_at

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

  • created_at

Authorizations
Path parameters
data_poolstringRequired

The data pool identifier.

Query parameters
filter[name]stringOptional

Filter results by name.

filter[id]stringOptional

Filter results by id.

filter[,]stringOptional

Filter results by ,.

includestringOptional

Comma-separated list of relationships to include. Available: name, description

sortstringOptional

Sort field. Prefix with - for descending. Available: created_at

pageinteger · min: 1Optional

Page number for pagination.

Default: 1
per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses
chevron-right
200

Successful response

application/json
get
/api/v1/data-pool/{data_pool}

Update

put

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field
Type
Required

name

string

description

string

Authorizations
Path parameters
data_poolstringRequired

The data pool identifier.

Body
descriptionstring · max: 255 · nullableOptional
namestring · min: 3 · max: 100Optional
Responses
chevron-right
200

Successful response

application/json
put
/api/v1/data-pool/{data_pool}

Destroy

delete

Delete a data pool.

Authorizations
Path parameters
data_poolstringRequired

The data pool identifier.

Responses
chevron-right
200

Successful response

application/json
messagestringOptional
delete
/api/v1/data-pool/{data_pool}

Index

get

Pagination

Pagination is available for this request. Please see the section on using pagination for more details.

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

  • flow

  • flow_count

  • flowExists

  • flowRun

  • flowRun_count

  • flowRunExists

  • flowStep

  • flowStep_count

  • flowStepExists

  • entityType

  • entityType_count

  • entityTypeExists

  • dataPool

  • dataPool_count

  • dataPoolExists

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

  • flow_id

  • flow_run_id

  • step_id

  • entity_type_id

  • value

  • created_before

  • created_after

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

  • created_at

  • id

Authorizations
Path parameters
data_poolstringRequired

The data pool identifier.

Query parameters
filter[flow_id]stringOptional

Filter results by flow_id.

filter[flow_run_id]stringOptional

Filter results by flow_run_id.

filter[step_id]stringOptional

Filter results by step_id.

filter[entity_type_id]stringOptional

Filter results by entity_type_id.

filter[value]stringOptional

Filter results by value.

filter[created_before]stringOptional

Filter results by created_before.

filter[created_after]stringOptional

Filter results by created_after.

includestringOptional

Comma-separated list of relationships to include. Available: flow, flowRun, flowStep, entityType, dataPool

sortstringOptional

Sort field. Prefix with - for descending. Available: created_at, id

pageinteger · min: 1Optional

Page number for pagination.

Default: 1
per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses
chevron-right
200

Successful response

application/json
get
/api/v1/data-pool/{data_pool}/deduped-data

Download

get

Download for download.

Authorizations
Path parameters
data_poolstringRequired

The data pool identifier.

Responses
chevron-right
200

Successful response

application/json
objectOptional
get
/api/v1/data-pool/{data_pool}/deduped-data/download

Import

post

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field
Type
Required

deduped_data_file

Authorizations
Path parameters
data_poolstringRequired

The data pool identifier.

Body
deduped_data_filestringRequired
Responses
chevron-right
200

Successful response

application/json
objectOptional
post
/api/v1/data-pool/{data_pool}/deduped-data/import

Destroy

delete

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field
Type
Required

ids

Authorizations
Path parameters
idstringRequired

The unique identifier of the id.

Responses
chevron-right
200

Successful response

application/json
messagestringOptional
delete
/api/v1/data-pool/{id}/deduped-data/delete-records

Last updated

Was this helpful?