Payload Metadata

Index

get

Pagination

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

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.

• id

• flow_run_id

• flow_step_id

• flow_log_id

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

ApiKeyAuth

Query parameters

filter[id]stringOptional

Filter results by id.

filter[flow_run_id]stringOptional

Filter results by flow_run_id.

filter[flow_step_id]stringOptional

Filter results by flow_step_id.

filter[flow_log_id]stringOptional

Filter results by flow_log_id.

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/payload-metadata

HTTPcURLJavaScriptPython

GET /api/v1/payload-metadata HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "flow_version_id": 1,
      "flow_step_id": 1,
      "flow_run_id": 1,
      "payload_store_reference": "example_payload_store_reference",
      "payload_size": "example_payload_size",
      "dropped": "example_dropped"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/payload-metadata",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/payload-metadata?page=1",
    "last": "https://api.example.com/api/v1/payload-metadata?page=1",
    "prev": null,
    "next": null
  }
}

Download

get

Download for download.

Authorizations

ApiKeyAuth

Path parameters

payloadMetadatumstringRequired

The payloadMetadatum identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

get

/api/v1/payload-metadata/{payloadMetadatum}/download

HTTPcURLJavaScriptPython

GET /api/v1/payload-metadata/{payloadMetadatum}/download HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{}

Get Meta

get

Get Meta for meta.

Authorizations

ApiKeyAuth

Path parameters

payloadMetadatumstringRequired

The payloadMetadatum identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get

/api/v1/payload-metadata/{payloadMetadatum}/meta

HTTPcURLJavaScriptPython

GET /api/v1/payload-metadata/{payloadMetadatum}/meta HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

No content

Show

get

Get a single payload metadata.

Authorizations

ApiKeyAuth

Path parameters

payload_metadatumstringRequired

The payload metadatum identifier.

Query parameters

filter[id]stringOptional

Filter results by id.

filter[flow_run_id]stringOptional

Filter results by flow_run_id.

filter[flow_step_id]stringOptional

Filter results by flow_step_id.

filter[flow_log_id]stringOptional

Filter results by flow_log_id.

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/payload-metadata/{payload_metadatum}

HTTPcURLJavaScriptPython

GET /api/v1/payload-metadata/{payload_metadatum} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": {
    "id": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "flow_version_id": 1,
    "flow_step_id": 1,
    "flow_run_id": 1,
    "payload_store_reference": "example_payload_store_reference",
    "payload_size": "example_payload_size",
    "dropped": "example_dropped"
  }
}