Data Pool | API Reference (WIP) | Product documentation

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

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/data-pool

GET /api/v1/data-pool HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "name": "My Example",
      "description": "A description of the resource",
      "data_pool_template_id": 1,
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/data-pool",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/data-pool?page=1",
    "last": "https://api.example.com/api/v1/data-pool?page=1",
    "prev": null,
    "next": null
  }
}

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

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/data-pool

POST /api/v1/data-pool HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "description": "A description of the resource",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "name": "My Example",
    "description": "A description of the resource",
    "data_pool_template_id": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

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

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/data-pool/{data_pool}

GET /api/v1/data-pool/{data_pool} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": {
    "id": 1,
    "name": "My Example",
    "description": "A description of the resource",
    "data_pool_template_id": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

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

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/data-pool/{data_pool}

PUT /api/v1/data-pool/{data_pool} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "description": "A description of the resource",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "name": "My Example",
    "description": "A description of the resource",
    "data_pool_template_id": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Destroy

delete

Delete a data pool.

Authorizations

Path parameters

data_poolstringRequired

The data pool identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/data-pool/{data_pool}

DELETE /api/v1/data-pool/{data_pool} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "message": "Action completed successfully."
}

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

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/data-pool/{data_pool}/deduped-data

GET /api/v1/data-pool/{data_pool}/deduped-data HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "name": "My Example",
      "description": "A description of the resource",
      "data_pool_template_id": 1,
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/data-pool/{data_pool}/deduped-data",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/data-pool/{data_pool}/deduped-data?page=1",
    "last": "https://api.example.com/api/v1/data-pool/{data_pool}/deduped-data?page=1",
    "prev": null,
    "next": null
  }
}

Download

get

Download for download.

Authorizations

Path parameters

data_poolstringRequired

The data pool identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

get

/api/v1/data-pool/{data_pool}/deduped-data/download

GET /api/v1/data-pool/{data_pool}/deduped-data/download HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{}

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

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/data-pool/{data_pool}/deduped-data/import

POST /api/v1/data-pool/{data_pool}/deduped-data/import HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "deduped_data_file": "example_deduped_data_file"
}

{}

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

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

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

DELETE /api/v1/data-pool/{id}/deduped-data/delete-records HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "message": "Action completed successfully."
}

hashtagIndex

hashtagPagination

hashtagAvailable Includes

hashtagAvailable Filters

hashtagAvailable Fields

hashtagAvailable Sorts

hashtagStore

hashtagValidation Rules

hashtagShow

hashtagAvailable Includes

hashtagAvailable Filters

hashtagAvailable Fields

hashtagAvailable Sorts

hashtagUpdate

hashtagValidation Rules

hashtagDestroy

hashtagIndex

hashtagPagination

hashtagAvailable Includes

hashtagAvailable Filters

hashtagAvailable Sorts

hashtagDownload

hashtagImport

hashtagValidation Rules

hashtagDestroy

hashtagValidation Rules

Index

Pagination

Available Includes

Available Filters

Available Fields

Available Sorts

Store

Validation Rules

Show

Available Includes

Available Filters

Available Fields

Available Sorts

Update

Validation Rules

Destroy

Index

Pagination

Available Includes

Available Filters

Available Sorts

Download

Import

Validation Rules

Destroy

Validation Rules