# Models

## The PaginationMeta object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}}}}}
```

## The PaginationLinks object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The ErrorResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}}}
```

## The MessageResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"MessageResponse":{"type":"object","properties":{"message":{"type":"string"}}}}}}
```

## The ActivityLogs object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ActivityLogs":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"log_name":{"type":"string"},"description":{"type":"string"},"subject_id":{"type":"integer"},"subject_type":{"type":"string"},"causer_id":{"type":"integer"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"event":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"}}}}}}
```

## The ActivityLogsListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ActivityLogsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ActivityLogs"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"ActivityLogs":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"log_name":{"type":"string"},"description":{"type":"string"},"subject_id":{"type":"integer"},"subject_type":{"type":"string"},"causer_id":{"type":"integer"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"event":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The Ai object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"Ai":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}}}}
```

## The AiGenerateGenerateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"AiGenerateGenerateRequest":{"type":"object","properties":{"userPrompt":{"type":"string"},"examplePayload":{"type":"string"},"language":{"type":"string"}},"required":["userPrompt"]}}}}
```

## The AiReplyReplyRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"AiReplyReplyRequest":{"type":"object","properties":{"userReply":{"type":"string"}},"required":["userReply"]}}}}
```

## The AiListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"AiListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Ai"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Ai":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The AuthenticationImplementations object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"AuthenticationImplementations":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"endpoint_ids":{"type":"string"},"label":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"secret":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"endpoint":{"type":"string"},"method":{"type":"string"},"additional_endpoint_1":{"type":"string"},"additional_endpoint_2":{"type":"string"},"authentication_type_id":{"type":"integer"},"authentication_implementation_template_id":{"type":"object"},"authentication_type":{"type":"object"},"system_id":{"type":"integer"},"body_format":{"type":"string","enum":["none","form-data","raw","text"]},"data_type":{"type":"string","enum":["csv","json","txt","xml"]},"pre_script_version_id":{"type":"object"},"post_script_version_id":{"type":"object"},"timeout":{"type":"array","items":{"type":"object"}},"system":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"endpoints":{"type":"array","items":{"type":"object"}},"pre_script_version":{"type":"string"},"post_script_version":{"type":"string"},"modified":{"type":"string"},"help_link":{"type":"string"}}}}}}
```

## The AuthenticationImplementationsStoreEndpointsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"AuthenticationImplementationsStoreEndpointsRequest":{"type":"object","properties":{"endpoint_ids":{"type":"string","items":{"type":"integer"}}},"required":["endpoint_ids"]}}}}
```

## The AuthenticationImplementationsStoreVariablesRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"AuthenticationImplementationsStoreVariablesRequest":{"type":"object","properties":{"label":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"secret":{"type":"string"},"pivot":{"type":"object","properties":{"alias":{"type":"string"},"configurable":{"type":"string"},"required":{"type":"string"},"advanced":{"type":"string"}}}},"required":["label","key"]}}}}
```

## The AuthenticationImplementationsListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"AuthenticationImplementationsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AuthenticationImplementations"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"AuthenticationImplementations":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"endpoint_ids":{"type":"string"},"label":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"secret":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"endpoint":{"type":"string"},"method":{"type":"string"},"additional_endpoint_1":{"type":"string"},"additional_endpoint_2":{"type":"string"},"authentication_type_id":{"type":"integer"},"authentication_implementation_template_id":{"type":"object"},"authentication_type":{"type":"object"},"system_id":{"type":"integer"},"body_format":{"type":"string","enum":["none","form-data","raw","text"]},"data_type":{"type":"string","enum":["csv","json","txt","xml"]},"pre_script_version_id":{"type":"object"},"post_script_version_id":{"type":"object"},"timeout":{"type":"array","items":{"type":"object"}},"system":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"endpoints":{"type":"array","items":{"type":"object"}},"pre_script_version":{"type":"string"},"post_script_version":{"type":"string"},"modified":{"type":"string"},"help_link":{"type":"string"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The AuthenticationImplementationsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"AuthenticationImplementationsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuthenticationImplementations"}}},"AuthenticationImplementations":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"endpoint_ids":{"type":"string"},"label":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"secret":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"endpoint":{"type":"string"},"method":{"type":"string"},"additional_endpoint_1":{"type":"string"},"additional_endpoint_2":{"type":"string"},"authentication_type_id":{"type":"integer"},"authentication_implementation_template_id":{"type":"object"},"authentication_type":{"type":"object"},"system_id":{"type":"integer"},"body_format":{"type":"string","enum":["none","form-data","raw","text"]},"data_type":{"type":"string","enum":["csv","json","txt","xml"]},"pre_script_version_id":{"type":"object"},"post_script_version_id":{"type":"object"},"timeout":{"type":"array","items":{"type":"object"}},"system":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"endpoints":{"type":"array","items":{"type":"object"}},"pre_script_version":{"type":"string"},"post_script_version":{"type":"string"},"modified":{"type":"string"},"help_link":{"type":"string"}}}}}}
```

## The Blueprints object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"Blueprints":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"help_guide":{"type":"string"},"versionable":{"type":"string"},"active_marketplace_app_id":{"type":"integer"},"marketplace_company_id":{"type":"integer"},"public_company_id":{"type":"integer"},"marketplace_apps_count":{"type":"integer"},"update_available":{"type":"string"},"post_install_defaults":{"type":"array","items":{"type":"object"}},"labels":{"type":"array","items":{"type":"object"}}}}}}}
```

## The BlueprintsInstallInstallRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"BlueprintsInstallInstallRequest":{"type":"object","properties":{"flow_template_ids":{"type":"string"},"instances":{"type":"string"},"post_install":{"type":"string","properties":{"action":{"type":"string"}}}}}}}}
```

## The BlueprintsInstallActiveInstallRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"BlueprintsInstallActiveInstallRequest":{"type":"object","properties":{"flow_template_ids":{"type":"string"},"instances":{"type":"string"},"post_install":{"type":"string","properties":{"action":{"type":"string"}}}}}}}}
```

## The BlueprintsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"BlueprintsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Blueprints"}}},"Blueprints":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"help_guide":{"type":"string"},"versionable":{"type":"string"},"active_marketplace_app_id":{"type":"integer"},"marketplace_company_id":{"type":"integer"},"public_company_id":{"type":"integer"},"marketplace_apps_count":{"type":"integer"},"update_available":{"type":"string"},"post_install_defaults":{"type":"array","items":{"type":"object"}},"labels":{"type":"array","items":{"type":"object"}}}}}}}
```

## The CacheStep object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"CacheStep":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"scope":{"type":"string"},"flow_id":{"type":"string"},"ttl_unit":{"type":"string"},"ttl_number":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}}}}
```

## The CacheStepStoreRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"CacheStepStoreRequest":{"type":"object","properties":{"scope":{"type":"string"},"flow_id":{"type":"string"},"ttl_unit":{"type":"string"},"ttl_number":{"type":"string"}},"required":["scope"]}}}}
```

## The CacheStepListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"CacheStepListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CacheStep"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"CacheStep":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"scope":{"type":"string"},"flow_id":{"type":"string"},"ttl_unit":{"type":"string"},"ttl_number":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The CacheStepResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"CacheStepResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CacheStep"}}},"CacheStep":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"scope":{"type":"string"},"flow_id":{"type":"string"},"ttl_unit":{"type":"string"},"ttl_number":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}}}}
```

## The Caches object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"Caches":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"scope":{"type":"string"},"ttl":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"flow_id":{"type":"integer"},"cache_template_id":{"type":"integer"},"content":{"type":"string"},"ttl_unit":{"type":"string"},"ttl_number":{"type":"string"},"flow":{"type":"string"}}}}}}
```

## The CachesUpdateContentRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"CachesUpdateContentRequest":{"type":"object","properties":{"content":{"type":"string","nullable":true}}}}}}
```

## The CachesUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"CachesUpdateRequest":{"type":"object","properties":{"ttl_unit":{"type":"string","nullable":true},"ttl_number":{"type":"string","nullable":true},"name":{"type":"string"}},"required":["name"]}}}}
```

## The CachesListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"CachesListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Caches"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Caches":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"scope":{"type":"string"},"ttl":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"flow_id":{"type":"integer"},"cache_template_id":{"type":"integer"},"content":{"type":"string"},"ttl_unit":{"type":"string"},"ttl_number":{"type":"string"},"flow":{"type":"string"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The CachesResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"CachesResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Caches"}}},"Caches":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"scope":{"type":"string"},"ttl":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"flow_id":{"type":"integer"},"cache_template_id":{"type":"integer"},"content":{"type":"string"},"ttl_unit":{"type":"string"},"ttl_number":{"type":"string"},"flow":{"type":"string"}}}}}}
```

## The Certificates object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"Certificates":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"connector_id":{"type":"string"},"certificate":{"type":"string"},"passphrase":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"object"},"user_id":{"type":"object"},"connector":{"type":"object"},"user":{"type":"object"}}}}}}
```

## The CertificatesStoreRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"CertificatesStoreRequest":{"type":"object","properties":{"connector_id":{"type":"string","nullable":true},"certificate":{"type":"string"},"passphrase":{"type":"string","maxLength":1000,"nullable":true}},"required":["certificate"]}}}}
```

## The CertificatesResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"CertificatesResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Certificates"}}},"Certificates":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"connector_id":{"type":"string"},"certificate":{"type":"string"},"passphrase":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"object"},"user_id":{"type":"object"},"connector":{"type":"object"},"user":{"type":"object"}}}}}}
```

## The ConnectionPools object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ConnectionPools":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"limit":{"type":"integer"},"timeout":{"type":"integer","items":{"type":"object"}},"created_at":{"type":"string","format":"date-time","items":{"type":"object"}},"updated_at":{"type":"string","format":"date-time","items":{"type":"object"}},"name":{"type":"string"},"connectors":{"type":"array","items":{"type":"object"}}}}}}}
```

## The ConnectionPoolsStoreRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ConnectionPoolsStoreRequest":{"type":"object","properties":{"limit":{"type":"integer","minimum":1},"timeout":{"type":"integer","minimum":1,"nullable":true},"name":{"type":"string","maxLength":255}},"required":["limit","name"]}}}}
```

## The ConnectionPoolsUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ConnectionPoolsUpdateRequest":{"type":"object","properties":{"limit":{"type":"integer","minimum":1},"timeout":{"type":"integer","minimum":1,"nullable":true},"name":{"type":"string","minLength":1,"maxLength":255}}}}}}
```

## The ConnectionPoolsListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ConnectionPoolsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ConnectionPools"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"ConnectionPools":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"limit":{"type":"integer"},"timeout":{"type":"integer","items":{"type":"object"}},"created_at":{"type":"string","format":"date-time","items":{"type":"object"}},"updated_at":{"type":"string","format":"date-time","items":{"type":"object"}},"name":{"type":"string"},"connectors":{"type":"array","items":{"type":"object"}}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The ConnectionPoolsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ConnectionPoolsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ConnectionPools"}}},"ConnectionPools":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"limit":{"type":"integer"},"timeout":{"type":"integer","items":{"type":"object"}},"created_at":{"type":"string","format":"date-time","items":{"type":"object"}},"updated_at":{"type":"string","format":"date-time","items":{"type":"object"}},"name":{"type":"string"},"connectors":{"type":"array","items":{"type":"object"}}}}}}}
```

## The ConnectorInstances object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ConnectorInstances":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"authentication_implementation_template_id":{"type":"string"},"timezone":{"type":"string"},"date_format":{"type":"string"},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"rate_limit_duration":{"type":"integer"},"connection_pool_id":{"type":"integer"},"variable_templates":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}}}}
```

## The ConnectorInstancesStoreRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ConnectorInstancesStoreRequest":{"type":"object","properties":{"authentication_implementation_template_id":{"type":"string"},"timezone":{"type":"string"},"date_format":{"type":"string"},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"rate_limit_duration":{"type":"integer"},"connection_pool_id":{"type":"integer","nullable":true},"variable_templates":{"type":"string","nullable":true,"properties":{"*":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string","nullable":true},"label":{"type":"string"},"secret":{"type":"boolean","nullable":true},"locked":{"type":"boolean","nullable":true},"pivot":{"type":"object","properties":{"alias":{"type":"string","nullable":true},"configurable":{"type":"boolean","nullable":true},"required":{"type":"boolean","nullable":true},"advanced":{"type":"boolean","nullable":true}}}}}}},"name":{"type":"string"}},"required":["authentication_implementation_template_id","date_format","name","rate_limit_duration","rate_limit_unit","timezone","variable_templates"]}}}}
```

## The ConnectorInstancesResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ConnectorInstancesResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ConnectorInstances"}}},"ConnectorInstances":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"authentication_implementation_template_id":{"type":"string"},"timezone":{"type":"string"},"date_format":{"type":"string"},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"rate_limit_duration":{"type":"integer"},"connection_pool_id":{"type":"integer"},"variable_templates":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}}}}
```

## The Connectors object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"Connectors":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"authentication_implementation_id":{"type":"string"},"timezone":{"type":"string"},"date_format":{"type":"string"},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"rate_limit_duration":{"type":"integer"},"connection_pool_id":{"type":"integer"},"variables":{"type":"string","items":{"type":"object"}},"session_id":{"type":"string"},"platform_app_key":{"type":"string"},"certificate_id":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"authentication_implementation":{"type":"array","items":{"type":"object"}},"system":{"type":"string"},"certificate":{"type":"string"}}}}}}
```

## The ConnectorsStoreRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ConnectorsStoreRequest":{"type":"object","properties":{"authentication_implementation_id":{"type":"string"},"timezone":{"type":"string"},"date_format":{"type":"string"},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"rate_limit_duration":{"type":"integer"},"connection_pool_id":{"type":"integer","nullable":true},"variables":{"type":"string","nullable":true,"properties":{"*":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string","nullable":true},"label":{"type":"string"},"secret":{"type":"boolean","nullable":true},"locked":{"type":"boolean","nullable":true},"pivot":{"type":"object","properties":{"alias":{"type":"string","nullable":true},"configurable":{"type":"boolean","nullable":true},"required":{"type":"boolean","nullable":true},"advanced":{"type":"boolean","nullable":true}}}}}}},"session_id":{"type":"string","nullable":true},"platform_app_key":{"type":"string"},"certificate_id":{"type":"string","nullable":true},"name":{"type":"string"}},"required":["authentication_implementation_id","date_format","name","rate_limit_duration","rate_limit_unit","timezone","variables"]}}}}
```

## The ConnectorsUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ConnectorsUpdateRequest":{"type":"object","properties":{"authentication_implementation_id":{"type":"string"},"type":{"type":"string"},"timezone":{"type":"string"},"date_format":{"type":"string"},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"rate_limit_duration":{"type":"integer"},"connection_pool_id":{"type":"integer","nullable":true},"variables":{"type":"string","properties":{"*":{"type":"object","properties":{"id":{"type":"string"},"key":{"type":"string"},"value":{"type":"string","nullable":true},"label":{"type":"string"},"secret":{"type":"boolean","nullable":true},"locked":{"type":"boolean","nullable":true},"pivot":{"type":"object","properties":{"alias":{"type":"string","nullable":true},"configurable":{"type":"boolean","nullable":true},"required":{"type":"boolean","nullable":true},"advanced":{"type":"boolean","nullable":true}}}}}}},"name":{"type":"string"}},"required":["variables"]}}}}
```

## The ConnectorsListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ConnectorsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Connectors"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Connectors":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"authentication_implementation_id":{"type":"string"},"timezone":{"type":"string"},"date_format":{"type":"string"},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"rate_limit_duration":{"type":"integer"},"connection_pool_id":{"type":"integer"},"variables":{"type":"string","items":{"type":"object"}},"session_id":{"type":"string"},"platform_app_key":{"type":"string"},"certificate_id":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"authentication_implementation":{"type":"array","items":{"type":"object"}},"system":{"type":"string"},"certificate":{"type":"string"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The ConnectorsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ConnectorsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Connectors"}}},"Connectors":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"authentication_implementation_id":{"type":"string"},"timezone":{"type":"string"},"date_format":{"type":"string"},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"rate_limit_duration":{"type":"integer"},"connection_pool_id":{"type":"integer"},"variables":{"type":"string","items":{"type":"object"}},"session_id":{"type":"string"},"platform_app_key":{"type":"string"},"certificate_id":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"authentication_implementation":{"type":"array","items":{"type":"object"}},"system":{"type":"string"},"certificate":{"type":"string"}}}}}}
```

## The CrossReferenceLookups object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"CrossReferenceLookups":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"cross_reference_lookup_template_id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string","items":{"type":"object"}},"default_value":{"type":"string","items":{"type":"object"}},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"left_value":{"type":"string"},"right_value":{"type":"string"},"cross_reference_lookup_values":{"type":"array","items":{"type":"object"}}}}}}}
```

## The CrossReferenceLookupsUploadUploadRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"CrossReferenceLookupsUploadUploadRequest":{"type":"object","properties":{"private":{"type":"string"}}}}}}
```

## The CrossReferenceLookupsStoreCrossReferenceLookupValuesRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"CrossReferenceLookupsStoreCrossReferenceLookupValuesRequest":{"type":"object","properties":{"left_value":{"type":"string","nullable":true},"right_value":{"type":"string","nullable":true}}}}}}
```

## The CrossReferenceLookupsUpdateCrossReferenceLookupValuesRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"CrossReferenceLookupsUpdateCrossReferenceLookupValuesRequest":{"type":"object","properties":{"left_value":{"type":"string","nullable":true},"right_value":{"type":"string","nullable":true}}}}}}
```

## The CrossReferenceLookupsImportImportRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"CrossReferenceLookupsImportImportRequest":{"type":"object","properties":{"values_file":{"type":"string"}},"required":["values_file"]}}}}
```

## The CrossReferenceLookupsUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"CrossReferenceLookupsUpdateRequest":{"type":"object","properties":{"description":{"type":"string"},"default_value":{"type":"string","nullable":true},"name":{"type":"string"}}}}}}
```

## The CrossReferenceLookupsStoreRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"CrossReferenceLookupsStoreRequest":{"type":"object","properties":{"description":{"type":"string"},"default_value":{"type":"string","nullable":true},"name":{"type":"string"}},"required":["description","name"]}}}}
```

## The CrossReferenceLookupsListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"CrossReferenceLookupsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CrossReferenceLookups"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"CrossReferenceLookups":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"cross_reference_lookup_template_id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string","items":{"type":"object"}},"default_value":{"type":"string","items":{"type":"object"}},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"left_value":{"type":"string"},"right_value":{"type":"string"},"cross_reference_lookup_values":{"type":"array","items":{"type":"object"}}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The CrossReferenceLookupsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"CrossReferenceLookupsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CrossReferenceLookups"}}},"CrossReferenceLookups":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"cross_reference_lookup_template_id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string","items":{"type":"object"}},"default_value":{"type":"string","items":{"type":"object"}},"created_at":{"type":"string"},"updated_at":{"type":"string"},"deleted_at":{"type":"string"},"left_value":{"type":"string"},"right_value":{"type":"string"},"cross_reference_lookup_values":{"type":"array","items":{"type":"object"}}}}}}}
```

## The DataPool object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"DataPool":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"name":{"type":"string"},"description":{"type":"string"},"data_pool_template_id":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}}}}
```

## The DataPoolStoreRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"DataPoolStoreRequest":{"type":"object","properties":{"description":{"type":"string","maxLength":255,"nullable":true},"name":{"type":"string","minLength":3,"maxLength":100}},"required":["name"]}}}}
```

## The DataPoolUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"DataPoolUpdateRequest":{"type":"object","properties":{"description":{"type":"string","maxLength":255,"nullable":true},"name":{"type":"string","minLength":3,"maxLength":100}}}}}}
```

## The DataPoolImportImportRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"DataPoolImportImportRequest":{"type":"object","properties":{"deduped_data_file":{"type":"string"}},"required":["deduped_data_file"]}}}}
```

## The DataPoolListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"DataPoolListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DataPool"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"DataPool":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"name":{"type":"string"},"description":{"type":"string"},"data_pool_template_id":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The DataPoolResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"DataPoolResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DataPool"}}},"DataPool":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"name":{"type":"string"},"description":{"type":"string"},"data_pool_template_id":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}}}}
```

## The Endpoints object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"Endpoints":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"field_path":{"type":"string"},"tags":{"type":"string"},"label":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"secret":{"type":"string"},"variables":{"type":"string","items":{"type":"object"}},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"object"},"system_id":{"type":"object"},"system":{"type":"object"},"entity_type_id":{"type":"object"},"entity_type":{"type":"object"},"endpoint":{"type":"string"},"http_method":{"type":"string","enum":["CONNECT","DELETE","GET","HEAD","OPTIONS","PATCH","POST","PUT","TRACE"]},"data_type":{"type":"string","enum":["csv","json","txt","xml"]},"pagination_method":{"type":"string","enum":["Custom relative URI","Link Header","Next page token","Next Page URL","Page number parameter","Limit offset","default","PeopleVox","NetSuite SOAP","GraphQL Cursor","Database limit offset","Script"]},"deprecated_at":{"type":"string","format":"date-time"},"direction":{"type":"string","enum":["Send","Receive"]},"returns_multiple_records":{"type":"boolean"},"pre_script_version_id":{"type":"object"},"post_script_version_id":{"type":"array","items":{"type":"object"}},"endpoint_schema":{"type":"array","items":{"type":"object"}},"field_tags":{"type":"array","items":{"type":"object"}},"data_path":{"type":"array","items":{"type":"object"}},"body_format":{"type":"array","items":{"type":"object"},"enum":["none","form-data","raw","text"]},"raw_body":{"type":"array","items":{"type":"object"}},"filters":{"type":"array","items":{"type":"object"}},"modified":{"type":"array","items":{"type":"object"}},"help_link":{"type":"array","items":{"type":"object"}},"authentication_implementations":{"type":"array","items":{"type":"object"}},"pre_script_version":{"type":"string"},"post_script_version":{"type":"string"},"disable_header_addition":{"type":"boolean"},"response_encoding":{"type":"string","enum":["base64","none"]}}}}}}
```

## The EndpointsStoreFieldTagsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"EndpointsStoreFieldTagsRequest":{"type":"object","properties":{"field_path":{"type":"string"},"tags":{"type":"string","properties":{"*":{"type":"object","properties":{"field_tag_id":{"type":"integer"},"field_path":{"type":"string"},"tracked":{"type":"boolean"}}}}}},"required":["field_path","tags"]}}}}
```

## The EndpointsUpdatePaginationRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"EndpointsUpdatePaginationRequest":{"type":"object","properties":{"variables":{"type":"string","properties":{"*":{"type":"object","properties":{"alias":{"type":"string"},"value":{"type":"string","nullable":true}}}}},"request_options":{"type":"array","nullable":true,"properties":{"*":{"type":"object","properties":{"key":{"type":"string"},"alias":{"type":"string"},"value":{"type":"string","nullable":true}}}}}},"required":["request_options","variables"]}}}}
```

## The EndpointsStoreVariablesRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"EndpointsStoreVariablesRequest":{"type":"object","properties":{"label":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"secret":{"type":"string"},"pivot":{"type":"object","properties":{"alias":{"type":"string"},"configurable":{"type":"string"},"required":{"type":"string"},"advanced":{"type":"string"}}}},"required":["label","key"]}}}}
```

## The EndpointsListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"EndpointsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Endpoints"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Endpoints":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"field_path":{"type":"string"},"tags":{"type":"string"},"label":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"secret":{"type":"string"},"variables":{"type":"string","items":{"type":"object"}},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"object"},"system_id":{"type":"object"},"system":{"type":"object"},"entity_type_id":{"type":"object"},"entity_type":{"type":"object"},"endpoint":{"type":"string"},"http_method":{"type":"string","enum":["CONNECT","DELETE","GET","HEAD","OPTIONS","PATCH","POST","PUT","TRACE"]},"data_type":{"type":"string","enum":["csv","json","txt","xml"]},"pagination_method":{"type":"string","enum":["Custom relative URI","Link Header","Next page token","Next Page URL","Page number parameter","Limit offset","default","PeopleVox","NetSuite SOAP","GraphQL Cursor","Database limit offset","Script"]},"deprecated_at":{"type":"string","format":"date-time"},"direction":{"type":"string","enum":["Send","Receive"]},"returns_multiple_records":{"type":"boolean"},"pre_script_version_id":{"type":"object"},"post_script_version_id":{"type":"array","items":{"type":"object"}},"endpoint_schema":{"type":"array","items":{"type":"object"}},"field_tags":{"type":"array","items":{"type":"object"}},"data_path":{"type":"array","items":{"type":"object"}},"body_format":{"type":"array","items":{"type":"object"},"enum":["none","form-data","raw","text"]},"raw_body":{"type":"array","items":{"type":"object"}},"filters":{"type":"array","items":{"type":"object"}},"modified":{"type":"array","items":{"type":"object"}},"help_link":{"type":"array","items":{"type":"object"}},"authentication_implementations":{"type":"array","items":{"type":"object"}},"pre_script_version":{"type":"string"},"post_script_version":{"type":"string"},"disable_header_addition":{"type":"boolean"},"response_encoding":{"type":"string","enum":["base64","none"]}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The EndpointsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"EndpointsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Endpoints"}}},"Endpoints":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"field_path":{"type":"string"},"tags":{"type":"string"},"label":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"secret":{"type":"string"},"variables":{"type":"string","items":{"type":"object"}},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"object"},"system_id":{"type":"object"},"system":{"type":"object"},"entity_type_id":{"type":"object"},"entity_type":{"type":"object"},"endpoint":{"type":"string"},"http_method":{"type":"string","enum":["CONNECT","DELETE","GET","HEAD","OPTIONS","PATCH","POST","PUT","TRACE"]},"data_type":{"type":"string","enum":["csv","json","txt","xml"]},"pagination_method":{"type":"string","enum":["Custom relative URI","Link Header","Next page token","Next Page URL","Page number parameter","Limit offset","default","PeopleVox","NetSuite SOAP","GraphQL Cursor","Database limit offset","Script"]},"deprecated_at":{"type":"string","format":"date-time"},"direction":{"type":"string","enum":["Send","Receive"]},"returns_multiple_records":{"type":"boolean"},"pre_script_version_id":{"type":"object"},"post_script_version_id":{"type":"array","items":{"type":"object"}},"endpoint_schema":{"type":"array","items":{"type":"object"}},"field_tags":{"type":"array","items":{"type":"object"}},"data_path":{"type":"array","items":{"type":"object"}},"body_format":{"type":"array","items":{"type":"object"},"enum":["none","form-data","raw","text"]},"raw_body":{"type":"array","items":{"type":"object"}},"filters":{"type":"array","items":{"type":"object"}},"modified":{"type":"array","items":{"type":"object"}},"help_link":{"type":"array","items":{"type":"object"}},"authentication_implementations":{"type":"array","items":{"type":"object"}},"pre_script_version":{"type":"string"},"post_script_version":{"type":"string"},"disable_header_addition":{"type":"boolean"},"response_encoding":{"type":"string","enum":["base64","none"]}}}}}}
```

## The Filters object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"Filters":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"type":{"type":"string"},"comparison":{"type":"string"},"value":{"type":"string"},"value_type":{"type":"string"},"keep_matching":{"type":"string"},"operator_logic":{"type":"string"},"match_order":{"type":"string"},"is_default":{"type":"string"},"location":{"type":"string"},"model_type":{"type":"string"},"model_id":{"type":"integer"},"date_format":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"field":{"type":"string"},"is_active":{"type":"boolean"}}}}}}
```

## The FiltersStoreRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FiltersStoreRequest":{"type":"object","properties":{"type":{"type":"string"},"comparison":{"type":"string"},"value":{"type":"string","maximum":1024,"nullable":true},"value_type":{"type":"string","nullable":true},"keep_matching":{"type":"string"},"operator_logic":{"type":"string","nullable":true},"match_order":{"type":"string"},"is_default":{"type":"string"},"location":{"type":"string","nullable":true},"model_type":{"type":"string"},"model_id":{"type":"integer"},"date_format":{"type":"string","nullable":true},"field":{"type":"string","minLength":1}},"required":["comparison","field","keep_matching","model_id","model_type","type"]}}}}
```

## The FiltersUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FiltersUpdateRequest":{"type":"object","properties":{"type":{"type":"string"},"comparison":{"type":"string"},"value":{"type":"string","maximum":1024},"value_type":{"type":"string","nullable":true},"keep_matching":{"type":"string"},"operator_logic":{"type":"string","nullable":true},"match_order":{"type":"string"},"is_default":{"type":"string"},"location":{"type":"string","nullable":true},"date_format":{"type":"string","nullable":true},"field":{"type":"string","minLength":1}}}}}}
```

## The FiltersListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FiltersListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Filters"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Filters":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"type":{"type":"string"},"comparison":{"type":"string"},"value":{"type":"string"},"value_type":{"type":"string"},"keep_matching":{"type":"string"},"operator_logic":{"type":"string"},"match_order":{"type":"string"},"is_default":{"type":"string"},"location":{"type":"string"},"model_type":{"type":"string"},"model_id":{"type":"integer"},"date_format":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"field":{"type":"string"},"is_active":{"type":"boolean"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The FiltersResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FiltersResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Filters"}}},"Filters":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"type":{"type":"string"},"comparison":{"type":"string"},"value":{"type":"string"},"value_type":{"type":"string"},"keep_matching":{"type":"string"},"operator_logic":{"type":"string"},"match_order":{"type":"string"},"is_default":{"type":"string"},"location":{"type":"string"},"model_type":{"type":"string"},"model_id":{"type":"integer"},"date_format":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"field":{"type":"string"},"is_active":{"type":"boolean"}}}}}}
```

## The FlowMetricValueSummaries object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowMetricValueSummaries":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}}}}
```

## The FlowMetricValueSummariesListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowMetricValueSummariesListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FlowMetricValueSummaries"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"FlowMetricValueSummaries":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The FlowRuns object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowRuns":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"name":{"type":"string"},"payload.id":{"type":"string"},"steps.name":{"type":"string"},"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"flow_id":{"type":"object"},"flow_version_id":{"type":"object"},"virtual_environment_version":{"type":"object"},"user_id":{"type":"integer"},"trigger":{"type":"string","enum":["API","Manual","Router","Webhook","Schedule","Shape","Retry","Event","Callback"]},"summary":{"type":"string"},"started_at":{"type":"string","format":"date-time"},"finished_at":{"type":"string","format":"date-time"},"duration":{"type":"object"},"retry_flow_run_id":{"type":"object"},"retried_flow_run":{"type":"array","items":{"type":"object"}},"has_warnings":{"type":"array","items":{"type":"object"}},"flow_run_logs":{"type":"array","items":{"type":"object"}},"flow":{"type":"array","items":{"type":"object"}},"flow_version":{"type":"array","items":{"type":"object"}},"metrics":{"type":"array","items":{"type":"object"}},"cpu_time":{"type":"string"},"payload_size":{"type":"string"},"operations_sent":{"type":"string"},"operations_received":{"type":"string"},"score":{"type":"string"},"starting_payload_count":{"type":"integer"},"starting_payload_size":{"type":"string"},"flow_steps_with_errors":{"type":"string"}}}}}}
```

## The FlowRunsListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowRunsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FlowRuns"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"FlowRuns":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"name":{"type":"string"},"payload.id":{"type":"string"},"steps.name":{"type":"string"},"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"flow_id":{"type":"object"},"flow_version_id":{"type":"object"},"virtual_environment_version":{"type":"object"},"user_id":{"type":"integer"},"trigger":{"type":"string","enum":["API","Manual","Router","Webhook","Schedule","Shape","Retry","Event","Callback"]},"summary":{"type":"string"},"started_at":{"type":"string","format":"date-time"},"finished_at":{"type":"string","format":"date-time"},"duration":{"type":"object"},"retry_flow_run_id":{"type":"object"},"retried_flow_run":{"type":"array","items":{"type":"object"}},"has_warnings":{"type":"array","items":{"type":"object"}},"flow_run_logs":{"type":"array","items":{"type":"object"}},"flow":{"type":"array","items":{"type":"object"}},"flow_version":{"type":"array","items":{"type":"object"}},"metrics":{"type":"array","items":{"type":"object"}},"cpu_time":{"type":"string"},"payload_size":{"type":"string"},"operations_sent":{"type":"string"},"operations_received":{"type":"string"},"score":{"type":"string"},"starting_payload_count":{"type":"integer"},"starting_payload_size":{"type":"string"},"flow_steps_with_errors":{"type":"string"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The FlowRunsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowRunsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FlowRuns"}}},"FlowRuns":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"name":{"type":"string"},"payload.id":{"type":"string"},"steps.name":{"type":"string"},"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"flow_id":{"type":"object"},"flow_version_id":{"type":"object"},"virtual_environment_version":{"type":"object"},"user_id":{"type":"integer"},"trigger":{"type":"string","enum":["API","Manual","Router","Webhook","Schedule","Shape","Retry","Event","Callback"]},"summary":{"type":"string"},"started_at":{"type":"string","format":"date-time"},"finished_at":{"type":"string","format":"date-time"},"duration":{"type":"object"},"retry_flow_run_id":{"type":"object"},"retried_flow_run":{"type":"array","items":{"type":"object"}},"has_warnings":{"type":"array","items":{"type":"object"}},"flow_run_logs":{"type":"array","items":{"type":"object"}},"flow":{"type":"array","items":{"type":"object"}},"flow_version":{"type":"array","items":{"type":"object"}},"metrics":{"type":"array","items":{"type":"object"}},"cpu_time":{"type":"string"},"payload_size":{"type":"string"},"operations_sent":{"type":"string"},"operations_received":{"type":"string"},"score":{"type":"string"},"starting_payload_count":{"type":"integer"},"starting_payload_size":{"type":"string"},"flow_steps_with_errors":{"type":"string"}}}}}}
```

## The FlowRunLog object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowRunLog":{"type":"object","properties":{"id":{"type":"integer"},"flow_run_id":{"type":"integer"},"flow_step_id":{"type":"integer"},"log_level":{"type":"string"},"log_message":{"type":"string"},"message":{"type":"array","items":{"type":"object"}},"meta":{"type":"object"},"page_number":{"type":"string"},"attempts":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"flow_run":{"type":"object"},"flow_step":{"type":"object"},"flow_step_payload_count":{"type":"integer"},"flow_run_log_metadata":{"type":"object"},"payload_ids":{"type":"string"}}}}}}
```

## The FlowRunLogsListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowRunLogsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FlowRunLog"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"FlowRunLog":{"type":"object","properties":{"id":{"type":"integer"},"flow_run_id":{"type":"integer"},"flow_step_id":{"type":"integer"},"log_level":{"type":"string"},"log_message":{"type":"string"},"message":{"type":"array","items":{"type":"object"}},"meta":{"type":"object"},"page_number":{"type":"string"},"attempts":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"flow_run":{"type":"object"},"flow_step":{"type":"object"},"flow_step_payload_count":{"type":"integer"},"flow_run_log_metadata":{"type":"object"},"payload_ids":{"type":"string"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The FlowRunLogResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowRunLogResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FlowRunLog"}}},"FlowRunLog":{"type":"object","properties":{"id":{"type":"integer"},"flow_run_id":{"type":"integer"},"flow_step_id":{"type":"integer"},"log_level":{"type":"string"},"log_message":{"type":"string"},"message":{"type":"array","items":{"type":"object"}},"meta":{"type":"object"},"page_number":{"type":"string"},"attempts":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"flow_run":{"type":"object"},"flow_step":{"type":"object"},"flow_step_payload_count":{"type":"integer"},"flow_run_log_metadata":{"type":"object"},"payload_ids":{"type":"string"}}}}}}
```

## The FlowSteps object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowSteps":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"first_step_id":{"type":"string"},"filter_logic_operator":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"flow_version_id":{"type":"integer"},"name":{"type":"string"},"microservice":{"type":"object"},"config":{"type":"object"},"parent_id":{"type":"object"},"flow_version":{"type":"object"},"children":{"type":"object"},"endpoint":{"type":"object"},"connector":{"type":"array","items":{"type":"object"}},"data_pool":{"type":"array","items":{"type":"object"}},"filters":{"type":"array","items":{"type":"object"}},"parent_flow_step":{"type":"array","items":{"type":"object"}},"routes":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"script_version":{"type":"array","items":{"type":"object"}},"cache":{"type":"array","items":{"type":"object"}},"payloads":{"type":"array","items":{"type":"object"}},"flow":{"type":"object"},"cross_references":{"type":"string"},"notes_count":{"type":"object"},"notification_group":{"type":"object"},"order":{"type":"string"}}}}}}
```

## The FlowStepsStoreRoutesRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowStepsStoreRoutesRequest":{"type":"object","properties":{"first_step_id":{"type":"string","nullable":true},"filter_logic_operator":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":255}},"required":["name"]}}}}
```

## The FlowStepsUpdateRoutesRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowStepsUpdateRoutesRequest":{"type":"object","properties":{"first_step_id":{"type":"string","nullable":true},"filter_logic_operator":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":255}}}}}}
```

## The FlowStepsListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowStepsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FlowSteps"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"FlowSteps":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"first_step_id":{"type":"string"},"filter_logic_operator":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"flow_version_id":{"type":"integer"},"name":{"type":"string"},"microservice":{"type":"object"},"config":{"type":"object"},"parent_id":{"type":"object"},"flow_version":{"type":"object"},"children":{"type":"object"},"endpoint":{"type":"object"},"connector":{"type":"array","items":{"type":"object"}},"data_pool":{"type":"array","items":{"type":"object"}},"filters":{"type":"array","items":{"type":"object"}},"parent_flow_step":{"type":"array","items":{"type":"object"}},"routes":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"script_version":{"type":"array","items":{"type":"object"}},"cache":{"type":"array","items":{"type":"object"}},"payloads":{"type":"array","items":{"type":"object"}},"flow":{"type":"object"},"cross_references":{"type":"string"},"notes_count":{"type":"object"},"notification_group":{"type":"object"},"order":{"type":"string"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The FlowStepsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowStepsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FlowSteps"}}},"FlowSteps":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"first_step_id":{"type":"string"},"filter_logic_operator":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"flow_version_id":{"type":"integer"},"name":{"type":"string"},"microservice":{"type":"object"},"config":{"type":"object"},"parent_id":{"type":"object"},"flow_version":{"type":"object"},"children":{"type":"object"},"endpoint":{"type":"object"},"connector":{"type":"array","items":{"type":"object"}},"data_pool":{"type":"array","items":{"type":"object"}},"filters":{"type":"array","items":{"type":"object"}},"parent_flow_step":{"type":"array","items":{"type":"object"}},"routes":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"script_version":{"type":"array","items":{"type":"object"}},"cache":{"type":"array","items":{"type":"object"}},"payloads":{"type":"array","items":{"type":"object"}},"flow":{"type":"object"},"cross_references":{"type":"string"},"notes_count":{"type":"object"},"notification_group":{"type":"object"},"order":{"type":"string"}}}}}}
```

## The FlowTemplates object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowTemplates":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time","items":{"type":"object"}},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"description":{"type":"string"},"step_count":{"type":"integer"},"cross_ref_count":{"type":"integer"},"script_count":{"type":"integer"},"system_count":{"type":"integer"},"webhook_count":{"type":"array","items":{"type":"object"}},"advanced":{"type":"array","items":{"type":"object"}},"system_templates":{"type":"array","items":{"type":"object"}},"steps":{"type":"array","items":{"type":"object"}},"schedules":{"type":"object"},"marketplace_company_id":{"type":"object"},"marketplace_company":{"type":"object"},"public_company_id":{"type":"object"},"public_company":{"type":"object"},"blueprint_id":{"type":"array","items":{"type":"object"}},"blueprint_version_number":{"type":"array","items":{"type":"object"}},"labels":{"type":"array","items":{"type":"object"}}}}}}}
```

## The FlowTemplatesListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowTemplatesListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FlowTemplates"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"FlowTemplates":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time","items":{"type":"object"}},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"description":{"type":"string"},"step_count":{"type":"integer"},"cross_ref_count":{"type":"integer"},"script_count":{"type":"integer"},"system_count":{"type":"integer"},"webhook_count":{"type":"array","items":{"type":"object"}},"advanced":{"type":"array","items":{"type":"object"}},"system_templates":{"type":"array","items":{"type":"object"}},"steps":{"type":"array","items":{"type":"object"}},"schedules":{"type":"object"},"marketplace_company_id":{"type":"object"},"marketplace_company":{"type":"object"},"public_company_id":{"type":"object"},"public_company":{"type":"object"},"blueprint_id":{"type":"array","items":{"type":"object"}},"blueprint_version_number":{"type":"array","items":{"type":"object"}},"labels":{"type":"array","items":{"type":"object"}}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The FlowTemplatesResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowTemplatesResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FlowTemplates"}}},"FlowTemplates":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time","items":{"type":"object"}},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"description":{"type":"string"},"step_count":{"type":"integer"},"cross_ref_count":{"type":"integer"},"script_count":{"type":"integer"},"system_count":{"type":"integer"},"webhook_count":{"type":"array","items":{"type":"object"}},"advanced":{"type":"array","items":{"type":"object"}},"system_templates":{"type":"array","items":{"type":"object"}},"steps":{"type":"array","items":{"type":"object"}},"schedules":{"type":"object"},"marketplace_company_id":{"type":"object"},"marketplace_company":{"type":"object"},"public_company_id":{"type":"object"},"public_company":{"type":"object"},"blueprint_id":{"type":"array","items":{"type":"object"}},"blueprint_version_number":{"type":"array","items":{"type":"object"}},"labels":{"type":"array","items":{"type":"object"}}}}}}}
```

## The FlowVersions object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowVersions":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"virtual_environment_id":{"type":"string"},"flow_version_id":{"type":"string"},"priority":{"type":"integer"},"cron_string":{"type":"string"},"microservice":{"type":"string"},"config":{"type":"string"},"flow_step_route_id":{"type":"integer"},"variables":{"type":"string","items":{"type":"object"}},"parent_id":{"type":"integer"},"type":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"date_format":{"type":"string"},"secret":{"type":"string"},"enabled_at":{"type":"string"},"created_at":{"type":"string","format":"date-time","items":{"type":"object"}},"updated_at":{"type":"string","format":"date-time","items":{"type":"object"}},"flow_id":{"type":"integer"},"flow_name":{"type":"string"},"flow_priority":{"type":"string"},"iteration":{"type":"string"},"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"is_deployed":{"type":"boolean"},"is_editable":{"type":"boolean"},"deployed_at":{"type":"object","format":"date-time"},"deployed_by":{"type":"object"},"deployed_by_user":{"type":"object"},"deployments":{"type":"array","items":{"type":"object"}},"has_callback_step":{"type":"array","items":{"type":"object"}},"steps":{"type":"array","items":{"type":"object"}},"runs":{"type":"string"},"latest_run":{"type":"string"},"schedules":{"type":"string"},"filters":{"type":"array","items":{"type":"object"}},"steps_count":{"type":"array","items":{"type":"object"}},"pivot":{"type":"string"},"saved_at":{"type":"string","format":"date-time"},"saved_by":{"type":"string"},"saved_by_user":{"type":"object"}}}}}}
```

## The FlowVersionsStoreDeploymentsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowVersionsStoreDeploymentsRequest":{"type":"object","properties":{"virtual_environment_id":{"type":"string","nullable":true},"flow_version_id":{"type":"string"},"priority":{"type":"integer","nullable":true},"deploy_disabled":{"type":"boolean","nullable":true}},"required":["flow_version_id"]}}}}
```

## The FlowVersionsUpdateDeploymentsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowVersionsUpdateDeploymentsRequest":{"type":"object","properties":{"virtual_environment_id":{"type":"string","nullable":true},"priority":{"type":"integer","nullable":true},"enabled_at":{"type":"string","format":"date-time","nullable":true},"deploy_disabled":{"type":"boolean","nullable":true}}}}}}
```

## The FlowVersionsStoreSchedulesRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowVersionsStoreSchedulesRequest":{"type":"object","properties":{"cron_string":{"type":"string"},"deployed_at":{"type":"string","format":"date-time","nullable":true}},"required":["cron_string"]}}}}
```

## The FlowVersionsUpdateSchedulesRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowVersionsUpdateSchedulesRequest":{"type":"object","properties":{"cron_string":{"type":"string"},"deployed_at":{"type":"string","format":"date-time","nullable":true}}}}}}
```

## The FlowVersionsStoreChildrenRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowVersionsStoreChildrenRequest":{"type":"object","properties":{"microservice":{"type":"string"},"config":{"type":"string"},"flow_step_route_id":{"type":"integer"},"variables":{"type":"string"},"deployed_at":{"type":"string","format":"date-time","nullable":true}},"required":["microservice","flow_step_route_id"]}}}}
```

## The FlowVersionsStoreParentsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowVersionsStoreParentsRequest":{"type":"object","properties":{"microservice":{"type":"string"},"config":{"type":"string"},"deployed_at":{"type":"string","format":"date-time","nullable":true}},"required":["microservice"]}}}}
```

## The FlowVersionsUpdateStepsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowVersionsUpdateStepsRequest":{"type":"object","properties":{"flow_version_id":{"type":"string"},"microservice":{"type":"string"},"config":{"type":"string"},"parent_id":{"type":"integer"},"variables":{"type":"string"},"deployed_at":{"type":"string","format":"date-time","nullable":true}}}}}}
```

## The FlowVersionsStoreStepsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowVersionsStoreStepsRequest":{"type":"object","properties":{"flow_version_id":{"type":"string"},"microservice":{"type":"string"},"config":{"type":"string"},"parent_id":{"type":"integer"},"variables":{"type":"string"},"deployed_at":{"type":"string","format":"date-time","nullable":true}},"required":["microservice"]}}}}
```

## The FlowVersionsStoreVariablesRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowVersionsStoreVariablesRequest":{"type":"object","properties":{"type":{"type":"string"},"key":{"type":"string","minLength":1},"value":{"type":"string","maximum":1024},"date_format":{"type":"string","nullable":true},"secret":{"type":"string"}},"required":["key","type"]}}}}
```

## The FlowVersionsUpdateVariablesRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowVersionsUpdateVariablesRequest":{"type":"object","properties":{"type":{"type":"string"},"key":{"type":"string","minLength":1},"value":{"type":"string","maximum":1024},"date_format":{"type":"string","nullable":true},"secret":{"type":"string"}},"required":["key","type"]}}}}
```

## The FlowVersionsUploadUploadRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowVersionsUploadUploadRequest":{"type":"object","properties":{"private":{"type":"string"}}}}}}
```

## The FlowVersionsListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowVersionsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FlowVersions"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"FlowVersions":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"virtual_environment_id":{"type":"string"},"flow_version_id":{"type":"string"},"priority":{"type":"integer"},"cron_string":{"type":"string"},"microservice":{"type":"string"},"config":{"type":"string"},"flow_step_route_id":{"type":"integer"},"variables":{"type":"string","items":{"type":"object"}},"parent_id":{"type":"integer"},"type":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"date_format":{"type":"string"},"secret":{"type":"string"},"enabled_at":{"type":"string"},"created_at":{"type":"string","format":"date-time","items":{"type":"object"}},"updated_at":{"type":"string","format":"date-time","items":{"type":"object"}},"flow_id":{"type":"integer"},"flow_name":{"type":"string"},"flow_priority":{"type":"string"},"iteration":{"type":"string"},"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"is_deployed":{"type":"boolean"},"is_editable":{"type":"boolean"},"deployed_at":{"type":"object","format":"date-time"},"deployed_by":{"type":"object"},"deployed_by_user":{"type":"object"},"deployments":{"type":"array","items":{"type":"object"}},"has_callback_step":{"type":"array","items":{"type":"object"}},"steps":{"type":"array","items":{"type":"object"}},"runs":{"type":"string"},"latest_run":{"type":"string"},"schedules":{"type":"string"},"filters":{"type":"array","items":{"type":"object"}},"steps_count":{"type":"array","items":{"type":"object"}},"pivot":{"type":"string"},"saved_at":{"type":"string","format":"date-time"},"saved_by":{"type":"string"},"saved_by_user":{"type":"object"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The FlowVersionsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowVersionsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FlowVersions"}}},"FlowVersions":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"virtual_environment_id":{"type":"string"},"flow_version_id":{"type":"string"},"priority":{"type":"integer"},"cron_string":{"type":"string"},"microservice":{"type":"string"},"config":{"type":"string"},"flow_step_route_id":{"type":"integer"},"variables":{"type":"string","items":{"type":"object"}},"parent_id":{"type":"integer"},"type":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"date_format":{"type":"string"},"secret":{"type":"string"},"enabled_at":{"type":"string"},"created_at":{"type":"string","format":"date-time","items":{"type":"object"}},"updated_at":{"type":"string","format":"date-time","items":{"type":"object"}},"flow_id":{"type":"integer"},"flow_name":{"type":"string"},"flow_priority":{"type":"string"},"iteration":{"type":"string"},"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"is_deployed":{"type":"boolean"},"is_editable":{"type":"boolean"},"deployed_at":{"type":"object","format":"date-time"},"deployed_by":{"type":"object"},"deployed_by_user":{"type":"object"},"deployments":{"type":"array","items":{"type":"object"}},"has_callback_step":{"type":"array","items":{"type":"object"}},"steps":{"type":"array","items":{"type":"object"}},"runs":{"type":"string"},"latest_run":{"type":"string"},"schedules":{"type":"string"},"filters":{"type":"array","items":{"type":"object"}},"steps_count":{"type":"array","items":{"type":"object"}},"pivot":{"type":"string"},"saved_at":{"type":"string","format":"date-time"},"saved_by":{"type":"string"},"saved_by_user":{"type":"object"}}}}}}
```

## The Flows object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"Flows":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"name":{"type":"string"},"enabled_at":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"format":{"type":"string","enum":["csv","json","txt","xml"]},"body":{"type":"string"},"deployed_at":{"type":"string"},"labels":{"type":"string","items":{"type":"object"}},"notification_groups":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"description":{"type":"string"},"layout_direction":{"type":"string"},"is_enabled":{"type":"object"},"latest_version":{"type":"object"},"current_version":{"type":"object"},"deployed_version":{"type":"object"},"latest_deployed_version":{"type":"array","items":{"type":"object"}},"versions":{"type":"array","items":{"type":"object"}},"version_type_counts":{"type":"array","items":{"type":"object"}},"message_brokers":{"type":"array","items":{"type":"object"}},"message_broker_queues":{"type":"array","items":{"type":"object"}},"notification_group_ids":{"type":"array","items":{"type":"object"}},"webhooks":{"type":"string"},"callbacks":{"type":"string"},"current_version_step_count":{"type":"integer"},"current_version_connector_count":{"type":"integer"},"current_version_script_count":{"type":"integer"},"current_version_cache_count":{"type":"integer"},"current_version_data_pool_count":{"type":"integer"},"current_version_cross_ref_count":{"type":"integer"},"use_queued_time":{"type":"string"},"remove_failed_payloads":{"type":"array","items":{"type":"object"}},"priority":{"type":"array","items":{"type":"object"}},"prod_flag":{"type":"array","items":{"type":"object"}},"deployments":{"type":"array","items":{"type":"object"}},"webhooks_count":{"type":"integer"},"callbacks_count":{"type":"integer"},"marketplace_app_id":{"type":"integer"},"blueprint_id":{"type":"integer"},"blueprint_version_number":{"type":"string"},"flow_folder_id":{"type":"integer"}}}}}}
```

## The FlowsStoreCallbacksRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowsStoreCallbacksRequest":{"type":"object","properties":{"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"format":{"type":"string","enum":["csv","json","txt","xml"]}}}}}}
```

## The FlowsUpdateCallbacksRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowsUpdateCallbacksRequest":{"type":"object","properties":{"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"format":{"type":"string","enum":["csv","json","txt","xml"]}}}}}}
```

## The FlowsUpdateVersionsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowsUpdateVersionsRequest":{"type":"object","properties":{"deployed_at":{"type":"string","format":"date-time","nullable":true}}}}}}
```

## The FlowsStoreWebhooksRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowsStoreWebhooksRequest":{"type":"object","properties":{"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"body":{"type":"string","nullable":true},"format":{"type":"string","enum":["csv","json","txt","xml"]}}}}}}
```

## The FlowsUpdateWebhooksRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowsUpdateWebhooksRequest":{"type":"object","properties":{"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"body":{"type":"string","nullable":true},"format":{"type":"string","enum":["csv","json","txt","xml"]},"hmac_algorithm":{"type":"string","nullable":true},"hmac_secret_key":{"type":"string","maxLength":128,"nullable":true}}}}}}
```

## The FlowsUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowsUpdateRequest":{"type":"object","properties":{"flow":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"description":{"type":"string","maxLength":255,"nullable":true},"enabled_at":{"type":"string","format":"date-time","nullable":true},"use_queued_time":{"type":"boolean"},"remove_failed_payloads":{"type":"boolean"},"priority":{"type":"integer","maximum":5,"minimum":1},"prod_flag":{"type":"boolean"}}},"labels":{"type":"string","properties":{"*":{"type":"object","properties":{"id":{"type":"string"}}}}},"notification_groups":{"type":"string"}},"required":["labels"]}}}}
```

## The FlowsDuplicateDuplicateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowsDuplicateDuplicateRequest":{"type":"object","properties":{"flow_version_id":{"type":"string"}},"required":["flow_version_id"]}}}}
```

## The FlowsExportExportRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowsExportExportRequest":{"type":"object","properties":{"flow_id":{"type":"integer"}},"required":["flow_id"]}}}}
```

## The FlowsImportImportRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowsImportImportRequest":{"type":"object","properties":{"flow":{"type":"string"},"metadata":{"type":"string"},"as_marketplace":{"type":"string"}},"required":["flow","metadata"]}}}}
```

## The FlowsStoreRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowsStoreRequest":{"type":"object","properties":{"flow":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"description":{"type":"string","maxLength":255,"nullable":true},"prod_flag":{"type":"boolean"}}}},"required":["flow"]}}}}
```

## The FlowsManualManualRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowsManualManualRequest":{"type":"object","properties":{"flow_id":{"type":"integer"},"version_id":{"type":"integer"},"payload":{"type":"string"},"flow_variables":{"type":"string"},"virtual_environment_id":{"type":"integer"}},"required":["flow_id","payload"]}}}}
```

## The FlowsStartStartRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowsStartStartRequest":{"type":"object","properties":{"flow_id":{"type":"integer"},"version_id":{"type":"integer"},"payload":{"type":"string"},"flow_variables":{"type":"string"},"virtual_environment_id":{"type":"integer"}},"required":["flow_id","payload"]}}}}
```

## The FlowsListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Flows"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Flows":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"name":{"type":"string"},"enabled_at":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"format":{"type":"string","enum":["csv","json","txt","xml"]},"body":{"type":"string"},"deployed_at":{"type":"string"},"labels":{"type":"string","items":{"type":"object"}},"notification_groups":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"description":{"type":"string"},"layout_direction":{"type":"string"},"is_enabled":{"type":"object"},"latest_version":{"type":"object"},"current_version":{"type":"object"},"deployed_version":{"type":"object"},"latest_deployed_version":{"type":"array","items":{"type":"object"}},"versions":{"type":"array","items":{"type":"object"}},"version_type_counts":{"type":"array","items":{"type":"object"}},"message_brokers":{"type":"array","items":{"type":"object"}},"message_broker_queues":{"type":"array","items":{"type":"object"}},"notification_group_ids":{"type":"array","items":{"type":"object"}},"webhooks":{"type":"string"},"callbacks":{"type":"string"},"current_version_step_count":{"type":"integer"},"current_version_connector_count":{"type":"integer"},"current_version_script_count":{"type":"integer"},"current_version_cache_count":{"type":"integer"},"current_version_data_pool_count":{"type":"integer"},"current_version_cross_ref_count":{"type":"integer"},"use_queued_time":{"type":"string"},"remove_failed_payloads":{"type":"array","items":{"type":"object"}},"priority":{"type":"array","items":{"type":"object"}},"prod_flag":{"type":"array","items":{"type":"object"}},"deployments":{"type":"array","items":{"type":"object"}},"webhooks_count":{"type":"integer"},"callbacks_count":{"type":"integer"},"marketplace_app_id":{"type":"integer"},"blueprint_id":{"type":"integer"},"blueprint_version_number":{"type":"string"},"flow_folder_id":{"type":"integer"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The FlowsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"FlowsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Flows"}}},"Flows":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"name":{"type":"string"},"enabled_at":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"format":{"type":"string","enum":["csv","json","txt","xml"]},"body":{"type":"string"},"deployed_at":{"type":"string"},"labels":{"type":"string","items":{"type":"object"}},"notification_groups":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"description":{"type":"string"},"layout_direction":{"type":"string"},"is_enabled":{"type":"object"},"latest_version":{"type":"object"},"current_version":{"type":"object"},"deployed_version":{"type":"object"},"latest_deployed_version":{"type":"array","items":{"type":"object"}},"versions":{"type":"array","items":{"type":"object"}},"version_type_counts":{"type":"array","items":{"type":"object"}},"message_brokers":{"type":"array","items":{"type":"object"}},"message_broker_queues":{"type":"array","items":{"type":"object"}},"notification_group_ids":{"type":"array","items":{"type":"object"}},"webhooks":{"type":"string"},"callbacks":{"type":"string"},"current_version_step_count":{"type":"integer"},"current_version_connector_count":{"type":"integer"},"current_version_script_count":{"type":"integer"},"current_version_cache_count":{"type":"integer"},"current_version_data_pool_count":{"type":"integer"},"current_version_cross_ref_count":{"type":"integer"},"use_queued_time":{"type":"string"},"remove_failed_payloads":{"type":"array","items":{"type":"object"}},"priority":{"type":"array","items":{"type":"object"}},"prod_flag":{"type":"array","items":{"type":"object"}},"deployments":{"type":"array","items":{"type":"object"}},"webhooks_count":{"type":"integer"},"callbacks_count":{"type":"integer"},"marketplace_app_id":{"type":"integer"},"blueprint_id":{"type":"integer"},"blueprint_version_number":{"type":"string"},"flow_folder_id":{"type":"integer"}}}}}}
```

## The Labels object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"Labels":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"colour":{"type":"string","enum":["blue","blue_inverted","cyan","cyan_inverted","gray","gray_inverted","green","green_inverted","orange","orange_inverted","pink","pink_inverted","purple","purple_inverted","red","red_inverted","yellow","yellow_inverted"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"}}}}}}
```

## The LabelsStoreRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"LabelsStoreRequest":{"type":"object","properties":{"colour":{"type":"string","enum":["blue","blue_inverted","cyan","cyan_inverted","gray","gray_inverted","green","green_inverted","orange","orange_inverted","pink","pink_inverted","purple","purple_inverted","red","red_inverted","yellow","yellow_inverted"]},"name":{"type":"string","maxLength":20}},"required":["colour","name"]}}}}
```

## The LabelsUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"LabelsUpdateRequest":{"type":"object","properties":{"colour":{"type":"string","enum":["blue","blue_inverted","cyan","cyan_inverted","gray","gray_inverted","green","green_inverted","orange","orange_inverted","pink","pink_inverted","purple","purple_inverted","red","red_inverted","yellow","yellow_inverted"]},"name":{"type":"string","maxLength":20}}}}}}
```

## The LabelsListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"LabelsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Labels"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Labels":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"colour":{"type":"string","enum":["blue","blue_inverted","cyan","cyan_inverted","gray","gray_inverted","green","green_inverted","orange","orange_inverted","pink","pink_inverted","purple","purple_inverted","red","red_inverted","yellow","yellow_inverted"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The LabelsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"LabelsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Labels"}}},"Labels":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"colour":{"type":"string","enum":["blue","blue_inverted","cyan","cyan_inverted","gray","gray_inverted","green","green_inverted","orange","orange_inverted","pink","pink_inverted","purple","purple_inverted","red","red_inverted","yellow","yellow_inverted"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"}}}}}}
```

## The Mapping object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"Mapping":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"flow_version_id":{"type":"string"},"flow_step_id":{"type":"string"},"mapping":{"type":"string"},"mapping_file":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}}}}
```

## The MappingStoreRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"MappingStoreRequest":{"type":"object","properties":{"flow_version_id":{"type":"string"},"flow_step_id":{"type":"string"},"mapping":{"type":"string"},"mapping_file":{"type":"string"}},"required":["flow_version_id","flow_step_id"]}}}}
```

## The MappingResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"MappingResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Mapping"}}},"Mapping":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"flow_version_id":{"type":"string"},"flow_step_id":{"type":"string"},"mapping":{"type":"string"},"mapping_file":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}}}}
```

## The MarketplaceApps object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"MarketplaceApps":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"help_guide":{"type":"string"},"flow_version_ids":{"type":"string"},"cross_reference_lookup_ids":{"type":"string"},"system_ids":{"type":"string"},"script_version_ids":{"type":"string"},"cache_ids":{"type":"string"},"data_pool_ids":{"type":"string"},"private":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"blueprint_id":{"type":"integer"},"name":{"type":"string"},"version":{"type":"integer"},"version_name":{"type":"string"},"installed_count":{"type":"integer"},"company_id":{"type":"integer"},"flow_count":{"type":"integer"},"system_count":{"type":"integer"},"script_count":{"type":"integer"},"data_pool_count":{"type":"array","items":{"type":"object"}},"cache_count":{"type":"array","items":{"type":"object"}},"cross_ref_count":{"type":"array","items":{"type":"object"}},"flow_templates":{"type":"array","items":{"type":"object"}},"cross_reference_lookup_templates":{"type":"array","items":{"type":"object"}},"system_templates":{"type":"array","items":{"type":"object"}},"script_templates":{"type":"array","items":{"type":"object"}},"cache_templates":{"type":"array","items":{"type":"object"}},"data_pool_templates":{"type":"array","items":{"type":"object"}},"company":{"type":"object"},"marketplace_company_id":{"type":"object"},"marketplace_company":{"type":"object"},"public_company_id":{"type":"object"},"public_company":{"type":"object"},"installs_avg_install_duration":{"type":"string"},"is_published":{"type":"boolean"}}}}}}
```

## The MarketplaceAppsStoreRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"MarketplaceAppsStoreRequest":{"type":"object","properties":{"help_guide":{"type":"string","format":"uri","nullable":true},"flow_version_ids":{"type":"string","items":{"type":"integer"}},"cross_reference_lookup_ids":{"type":"string","items":{"type":"integer"}},"system_ids":{"type":"string","items":{"type":"integer"}},"script_version_ids":{"type":"string","items":{"type":"integer"}},"cache_ids":{"type":"string","items":{"type":"integer"}},"data_pool_ids":{"type":"string","items":{"type":"integer"}},"private":{"type":"string"},"name":{"type":"string","maxLength":100},"labels":{"type":"array","properties":{"*":{"type":"object","properties":{"id":{"type":"string"}}}}}},"required":["labels","name"]}}}}
```

## The MarketplaceAppsUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"MarketplaceAppsUpdateRequest":{"type":"object","properties":{"flow_version_ids":{"type":"string","items":{"type":"integer"}},"cross_reference_lookup_ids":{"type":"string","items":{"type":"integer"}},"system_ids":{"type":"string","items":{"type":"integer"}},"script_version_ids":{"type":"string","items":{"type":"integer"}},"cache_ids":{"type":"string","items":{"type":"integer"}},"data_pool_ids":{"type":"string","items":{"type":"integer"}},"name":{"type":"string","maxLength":100}}}}}}
```

## The MarketplaceAppsInstallInstallRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"MarketplaceAppsInstallInstallRequest":{"type":"object","properties":{"flow_template_ids":{"type":"string"}}}}}}
```

## The MarketplaceAppsListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"MarketplaceAppsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MarketplaceApps"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"MarketplaceApps":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"help_guide":{"type":"string"},"flow_version_ids":{"type":"string"},"cross_reference_lookup_ids":{"type":"string"},"system_ids":{"type":"string"},"script_version_ids":{"type":"string"},"cache_ids":{"type":"string"},"data_pool_ids":{"type":"string"},"private":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"blueprint_id":{"type":"integer"},"name":{"type":"string"},"version":{"type":"integer"},"version_name":{"type":"string"},"installed_count":{"type":"integer"},"company_id":{"type":"integer"},"flow_count":{"type":"integer"},"system_count":{"type":"integer"},"script_count":{"type":"integer"},"data_pool_count":{"type":"array","items":{"type":"object"}},"cache_count":{"type":"array","items":{"type":"object"}},"cross_ref_count":{"type":"array","items":{"type":"object"}},"flow_templates":{"type":"array","items":{"type":"object"}},"cross_reference_lookup_templates":{"type":"array","items":{"type":"object"}},"system_templates":{"type":"array","items":{"type":"object"}},"script_templates":{"type":"array","items":{"type":"object"}},"cache_templates":{"type":"array","items":{"type":"object"}},"data_pool_templates":{"type":"array","items":{"type":"object"}},"company":{"type":"object"},"marketplace_company_id":{"type":"object"},"marketplace_company":{"type":"object"},"public_company_id":{"type":"object"},"public_company":{"type":"object"},"installs_avg_install_duration":{"type":"string"},"is_published":{"type":"boolean"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The MarketplaceAppsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"MarketplaceAppsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MarketplaceApps"}}},"MarketplaceApps":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"help_guide":{"type":"string"},"flow_version_ids":{"type":"string"},"cross_reference_lookup_ids":{"type":"string"},"system_ids":{"type":"string"},"script_version_ids":{"type":"string"},"cache_ids":{"type":"string"},"data_pool_ids":{"type":"string"},"private":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"blueprint_id":{"type":"integer"},"name":{"type":"string"},"version":{"type":"integer"},"version_name":{"type":"string"},"installed_count":{"type":"integer"},"company_id":{"type":"integer"},"flow_count":{"type":"integer"},"system_count":{"type":"integer"},"script_count":{"type":"integer"},"data_pool_count":{"type":"array","items":{"type":"object"}},"cache_count":{"type":"array","items":{"type":"object"}},"cross_ref_count":{"type":"array","items":{"type":"object"}},"flow_templates":{"type":"array","items":{"type":"object"}},"cross_reference_lookup_templates":{"type":"array","items":{"type":"object"}},"system_templates":{"type":"array","items":{"type":"object"}},"script_templates":{"type":"array","items":{"type":"object"}},"cache_templates":{"type":"array","items":{"type":"object"}},"data_pool_templates":{"type":"array","items":{"type":"object"}},"company":{"type":"object"},"marketplace_company_id":{"type":"object"},"marketplace_company":{"type":"object"},"public_company_id":{"type":"object"},"public_company":{"type":"object"},"installs_avg_install_duration":{"type":"string"},"is_published":{"type":"boolean"}}}}}}
```

## The MediaFiles object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"MediaFiles":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"model_type":{"type":"string"},"model_id":{"type":"integer"},"file_name":{"type":"string"},"mime_type":{"type":"string"},"expires_at":{"type":"string","format":"date-time"},"is_expired":{"type":"boolean"}}}}}}
```

## The MediaFilesListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"MediaFilesListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MediaFiles"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"MediaFiles":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"model_type":{"type":"string"},"model_id":{"type":"integer"},"file_name":{"type":"string"},"mime_type":{"type":"string"},"expires_at":{"type":"string","format":"date-time"},"is_expired":{"type":"boolean"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The MessageBrokerQueues object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"MessageBrokerQueues":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier","items":{"type":"object"}},"flow_id":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"array","items":{"type":"object"}},"message_broker_id":{"type":"array","items":{"type":"object"}},"flows":{"type":"array","items":{"type":"object"}},"message_broker":{"type":"object"}}}}}}
```

## The MessageBrokerQueuesStoreFlowsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"MessageBrokerQueuesStoreFlowsRequest":{"type":"object","properties":{"flow_id":{"type":"integer"}},"required":["flow_id"]}}}}
```

## The MessageBrokerQueuesListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"MessageBrokerQueuesListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MessageBrokerQueues"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"MessageBrokerQueues":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier","items":{"type":"object"}},"flow_id":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"array","items":{"type":"object"}},"message_broker_id":{"type":"array","items":{"type":"object"}},"flows":{"type":"array","items":{"type":"object"}},"message_broker":{"type":"object"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The MessageBrokerQueuesResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"MessageBrokerQueuesResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MessageBrokerQueues"}}},"MessageBrokerQueues":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier","items":{"type":"object"}},"flow_id":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"array","items":{"type":"object"}},"message_broker_id":{"type":"array","items":{"type":"object"}},"flows":{"type":"array","items":{"type":"object"}},"message_broker":{"type":"object"}}}}}}
```

## The MessageBrokers object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"MessageBrokers":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"description":{"type":"string"},"host":{"type":"string","items":{"type":"object"}},"port":{"type":"integer","items":{"type":"object"}},"protocol":{"type":"string","enum":["HTTP","FTP","SFTP","FTPS","S3","MySQL","PGSQL","SQLSRV"],"items":{"type":"object"}},"auth_type":{"type":"string","items":{"type":"object"}},"variables":{"type":"string","items":{"type":"object"}},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"flows":{"type":"array","items":{"type":"object"}},"message_broker_queues":{"type":"array","items":{"type":"object"}},"message_broker_queues_count":{"type":"array","items":{"type":"object"}},"flow_message_broker_queues":{"type":"array","items":{"type":"object"}}}}}}}
```

## The MessageBrokersUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"MessageBrokersUpdateRequest":{"type":"object","properties":{"description":{"type":"string","maxLength":100},"host":{"type":"string"},"port":{"type":"integer"},"protocol":{"type":"string","enum":["HTTP","FTP","SFTP","FTPS","S3","MySQL","PGSQL","SQLSRV"]},"auth_type":{"type":"string"},"variables":{"type":"string","properties":{"*":{"type":"object","properties":{"id":{"type":"string"},"key":{"type":"string"},"value":{"type":"string","nullable":true},"label":{"type":"string"},"secret":{"type":"boolean","nullable":true},"locked":{"type":"boolean","nullable":true},"pivot":{"type":"object","properties":{"alias":{"type":"string","nullable":true},"configurable":{"type":"boolean","nullable":true},"required":{"type":"boolean","nullable":true},"advanced":{"type":"boolean","nullable":true}}}}}}},"name":{"type":"string","maxLength":40,"pattern":"^[a-zA-Z0-9 -]+$"}},"required":["variables"]}}}}
```

## The MessageBrokersStoreRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"MessageBrokersStoreRequest":{"type":"object","properties":{"description":{"type":"string","maxLength":100},"host":{"type":"string"},"port":{"type":"integer"},"protocol":{"type":"string","enum":["HTTP","FTP","SFTP","FTPS","S3","MySQL","PGSQL","SQLSRV"]},"auth_type":{"type":"string"},"name":{"type":"string","maxLength":40,"pattern":"^[a-zA-Z0-9 -]+$"}},"required":["auth_type","description","host","name","port","protocol"]}}}}
```

## The MessageBrokersListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"MessageBrokersListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MessageBrokers"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"MessageBrokers":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"description":{"type":"string"},"host":{"type":"string","items":{"type":"object"}},"port":{"type":"integer","items":{"type":"object"}},"protocol":{"type":"string","enum":["HTTP","FTP","SFTP","FTPS","S3","MySQL","PGSQL","SQLSRV"],"items":{"type":"object"}},"auth_type":{"type":"string","items":{"type":"object"}},"variables":{"type":"string","items":{"type":"object"}},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"flows":{"type":"array","items":{"type":"object"}},"message_broker_queues":{"type":"array","items":{"type":"object"}},"message_broker_queues_count":{"type":"array","items":{"type":"object"}},"flow_message_broker_queues":{"type":"array","items":{"type":"object"}}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The MessageBrokersResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"MessageBrokersResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MessageBrokers"}}},"MessageBrokers":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"description":{"type":"string"},"host":{"type":"string","items":{"type":"object"}},"port":{"type":"integer","items":{"type":"object"}},"protocol":{"type":"string","enum":["HTTP","FTP","SFTP","FTPS","S3","MySQL","PGSQL","SQLSRV"],"items":{"type":"object"}},"auth_type":{"type":"string","items":{"type":"object"}},"variables":{"type":"string","items":{"type":"object"}},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"flows":{"type":"array","items":{"type":"object"}},"message_broker_queues":{"type":"array","items":{"type":"object"}},"message_broker_queues_count":{"type":"array","items":{"type":"object"}},"flow_message_broker_queues":{"type":"array","items":{"type":"object"}}}}}}}
```

## The ModelFilterValues object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ModelFilterValues":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"model_type":{"type":"string"},"model_id":{"type":"integer"},"filter_id":{"type":"integer"},"value":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"filter":{"type":"object"}}}}}}
```

## The ModelFilterValuesStoreRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ModelFilterValuesStoreRequest":{"type":"object","properties":{"model_type":{"type":"string"},"model_id":{"type":"integer"},"filter_id":{"type":"integer"},"value":{"type":"string","maxLength":1024}},"required":["filter_id","model_id","model_type","value"]}}}}
```

## The ModelFilterValuesUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ModelFilterValuesUpdateRequest":{"type":"object","properties":{"filter_id":{"type":"integer"},"value":{"type":"string","maxLength":1024}}}}}}
```

## The ModelFilterValuesListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ModelFilterValuesListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ModelFilterValues"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"ModelFilterValues":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"model_type":{"type":"string"},"model_id":{"type":"integer"},"filter_id":{"type":"integer"},"value":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"filter":{"type":"object"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The ModelFilterValuesResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ModelFilterValuesResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ModelFilterValues"}}},"ModelFilterValues":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"model_type":{"type":"string"},"model_id":{"type":"integer"},"filter_id":{"type":"integer"},"value":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"filter":{"type":"object"}}}}}}
```

## The ModelNotes object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ModelNotes":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"note":{"type":"string"},"private":{"type":"string"},"patchworks_only":{"type":"string"},"model_type":{"type":"string"},"model_id":{"type":"integer"},"colour":{"type":"string","enum":["blue","blue_inverted","cyan","cyan_inverted","gray","gray_inverted","green","green_inverted","orange","orange_inverted","pink","pink_inverted","purple","purple_inverted","red","red_inverted","yellow","yellow_inverted"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"user_id":{"type":"object"},"flow_step":{"type":"object"},"user":{"type":"object"}}}}}}
```

## The ModelNotesStoreRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ModelNotesStoreRequest":{"type":"object","properties":{"note":{"type":"string","minLength":1,"maxLength":65535},"private":{"type":"string"},"patchworks_only":{"type":"string"},"model_type":{"type":"string"},"model_id":{"type":"integer"},"colour":{"type":"string","enum":["blue","blue_inverted","cyan","cyan_inverted","gray","gray_inverted","green","green_inverted","orange","orange_inverted","pink","pink_inverted","purple","purple_inverted","red","red_inverted","yellow","yellow_inverted"]}},"required":["colour","model_id","model_type","note"]}}}}
```

## The ModelNotesUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ModelNotesUpdateRequest":{"type":"object","properties":{"note":{"type":"string","minLength":1,"maxLength":65535},"private":{"type":"string"},"patchworks_only":{"type":"string"},"colour":{"type":"string","enum":["blue","blue_inverted","cyan","cyan_inverted","gray","gray_inverted","green","green_inverted","orange","orange_inverted","pink","pink_inverted","purple","purple_inverted","red","red_inverted","yellow","yellow_inverted"]}}}}}}
```

## The ModelNotesListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ModelNotesListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ModelNotes"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"ModelNotes":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"note":{"type":"string"},"private":{"type":"string"},"patchworks_only":{"type":"string"},"model_type":{"type":"string"},"model_id":{"type":"integer"},"colour":{"type":"string","enum":["blue","blue_inverted","cyan","cyan_inverted","gray","gray_inverted","green","green_inverted","orange","orange_inverted","pink","pink_inverted","purple","purple_inverted","red","red_inverted","yellow","yellow_inverted"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"user_id":{"type":"object"},"flow_step":{"type":"object"},"user":{"type":"object"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The ModelNotesResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ModelNotesResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ModelNotes"}}},"ModelNotes":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"note":{"type":"string"},"private":{"type":"string"},"patchworks_only":{"type":"string"},"model_type":{"type":"string"},"model_id":{"type":"integer"},"colour":{"type":"string","enum":["blue","blue_inverted","cyan","cyan_inverted","gray","gray_inverted","green","green_inverted","orange","orange_inverted","pink","pink_inverted","purple","purple_inverted","red","red_inverted","yellow","yellow_inverted"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"user_id":{"type":"object"},"flow_step":{"type":"object"},"user":{"type":"object"}}}}}}
```

## The ModelVariables object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ModelVariables":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"variable_id":{"type":"string"},"alias":{"type":"string"},"configurable":{"type":"string"},"required":{"type":"string"},"advanced":{"type":"string"},"model_type":{"type":"string"},"model_id":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"variable":{"type":"object"},"modified":{"type":"string"}}}}}}
```

## The ModelVariablesStoreRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ModelVariablesStoreRequest":{"type":"object","properties":{"variable_id":{"type":"string"},"alias":{"type":"string","nullable":true},"configurable":{"type":"string"},"required":{"type":"string"},"advanced":{"type":"string"},"model_type":{"type":"string"},"model_id":{"type":"string"}},"required":["model_id","model_type","variable_id"]}}}}
```

## The ModelVariablesUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ModelVariablesUpdateRequest":{"type":"object","properties":{"alias":{"type":"string","nullable":true},"configurable":{"type":"string"},"required":{"type":"string"},"advanced":{"type":"string"}}}}}}
```

## The ModelVariablesListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ModelVariablesListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ModelVariables"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"ModelVariables":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"variable_id":{"type":"string"},"alias":{"type":"string"},"configurable":{"type":"string"},"required":{"type":"string"},"advanced":{"type":"string"},"model_type":{"type":"string"},"model_id":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"variable":{"type":"object"},"modified":{"type":"string"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The ModelVariablesResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ModelVariablesResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ModelVariables"}}},"ModelVariables":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"variable_id":{"type":"string"},"alias":{"type":"string"},"configurable":{"type":"string"},"required":{"type":"string"},"advanced":{"type":"string"},"model_type":{"type":"string"},"model_id":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"variable":{"type":"object"},"modified":{"type":"string"}}}}}}
```

## The My object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"My":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}}}}
```

## The MyListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"MyListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/My"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"My":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The Notifications object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"Notifications":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"read":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"type":{"type":"string"},"read_at":{"type":"string","format":"date-time"}}}}}}
```

## The NotificationsUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"NotificationsUpdateRequest":{"type":"object","properties":{"read":{"type":"string"}},"required":["read"]}}}}
```

## The NotificationsListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"NotificationsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Notifications"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Notifications":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"read":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"type":{"type":"string"},"read_at":{"type":"string","format":"date-time"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The NotificationsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"NotificationsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Notifications"}}},"Notifications":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"read":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"type":{"type":"string"},"read_at":{"type":"string","format":"date-time"}}}}}}
```

## The OauthAuthoriseAuthoriseRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"OauthAuthoriseAuthoriseRequest":{"type":"object","properties":{"authentication_implementation_id":{"type":"string"},"timezone":{"type":"string"},"date_format":{"type":"string"},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"rate_limit_duration":{"type":"integer"},"connection_pool_id":{"type":"integer"},"variables":{"type":"string"},"session_id":{"type":"string"},"platform_app_key":{"type":"string"},"certificate_id":{"type":"string"}},"required":["authentication_implementation_id","timezone","date_format","rate_limit_unit","rate_limit_duration"]}}}}
```

## The OauthReauthoriseReauthoriseRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"OauthReauthoriseReauthoriseRequest":{"type":"object","properties":{"authentication_implementation_id":{"type":"string"},"type":{"type":"string"},"timezone":{"type":"string"},"date_format":{"type":"string"},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"rate_limit_duration":{"type":"integer"},"connection_pool_id":{"type":"integer"},"variables":{"type":"string"}}}}}}
```

## The Packages object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"Packages":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"name":{"type":"string"},"notes":{"type":"string"},"created_by":{"type":"string","items":{"type":"object"}},"priority":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"created_by_user":{"type":"array","items":{"type":"object"}},"flow_versions":{"type":"array","items":{"type":"object"}},"virtual_environments":{"type":"array","items":{"type":"object"}},"deployments":{"type":"array","items":{"type":"object"}},"flow_versions_count":{"type":"integer"},"deployments_count":{"type":"integer"},"flow_version_deployments_count":{"type":"integer"}}}}}}
```

## The PackagesStoreFlowVersionsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"PackagesStoreFlowVersionsRequest":{"type":"object","properties":{"priority":{"type":"integer","minimum":1,"maximum":100,"nullable":true}}}}}}
```

## The PackagesUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"PackagesUpdateRequest":{"type":"object","properties":{"notes":{"type":"string","maxLength":255,"nullable":true},"name":{"type":"string","maxLength":255}}}}}}
```

## The PackagesStoreRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"PackagesStoreRequest":{"type":"object","properties":{"notes":{"type":"string","maxLength":255,"nullable":true},"name":{"type":"string","maxLength":255}},"required":["name"]}}}}
```

## The PackagesDeployDeployRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"PackagesDeployDeployRequest":{"type":"object","properties":{"notes":{"type":"string"}}}}}}
```

## The PackagesListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"PackagesListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Packages"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Packages":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"name":{"type":"string"},"notes":{"type":"string"},"created_by":{"type":"string","items":{"type":"object"}},"priority":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"created_by_user":{"type":"array","items":{"type":"object"}},"flow_versions":{"type":"array","items":{"type":"object"}},"virtual_environments":{"type":"array","items":{"type":"object"}},"deployments":{"type":"array","items":{"type":"object"}},"flow_versions_count":{"type":"integer"},"deployments_count":{"type":"integer"},"flow_version_deployments_count":{"type":"integer"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The PackagesResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"PackagesResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Packages"}}},"Packages":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"name":{"type":"string"},"notes":{"type":"string"},"created_by":{"type":"string","items":{"type":"object"}},"priority":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"created_by_user":{"type":"array","items":{"type":"object"}},"flow_versions":{"type":"array","items":{"type":"object"}},"virtual_environments":{"type":"array","items":{"type":"object"}},"deployments":{"type":"array","items":{"type":"object"}},"flow_versions_count":{"type":"integer"},"deployments_count":{"type":"integer"},"flow_version_deployments_count":{"type":"integer"}}}}}}
```

## The Patchworks object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"Patchworks":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"label":{"type":"string"},"colour":{"type":"string","enum":["blue","blue_inverted","cyan","cyan_inverted","gray","gray_inverted","green","green_inverted","orange","orange_inverted","pink","pink_inverted","purple","purple_inverted","red","red_inverted","yellow","yellow_inverted"]},"logo_url":{"type":"string"},"version":{"type":"integer"},"version_name":{"type":"string"},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"rate_limit_duration":{"type":"integer"},"system_type_id":{"type":"string"},"protocol":{"type":"string","enum":["HTTP","FTP","SFTP","FTPS","S3","MySQL","PGSQL","SQLSRV"]},"company_id":{"type":"string"},"date_format":{"type":"string"},"help_link":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}}}}
```

## The PatchworksStoreSystemTemplatesRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"PatchworksStoreSystemTemplatesRequest":{"type":"object","properties":{"label":{"type":"string"},"colour":{"type":"string","enum":["blue","blue_inverted","cyan","cyan_inverted","gray","gray_inverted","green","green_inverted","orange","orange_inverted","pink","pink_inverted","purple","purple_inverted","red","red_inverted","yellow","yellow_inverted"]},"logo_url":{"type":"string","format":"uri"},"version":{"type":"integer"},"version_name":{"type":"string"},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"rate_limit_duration":{"type":"integer"},"system_type_id":{"type":"string"},"protocol":{"type":"string","enum":["HTTP","FTP","SFTP","FTPS","S3","MySQL","PGSQL","SQLSRV"]},"company_id":{"type":"string"},"date_format":{"type":"string"},"help_link":{"type":"string","nullable":true},"name":{"type":"string"}},"required":["colour","company_id","date_format","label","logo_url","name","protocol","rate_limit_duration","rate_limit_unit","system_type_id","version","version_name"]}}}}
```

## The PatchworksUpdateSystemTemplatesRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"PatchworksUpdateSystemTemplatesRequest":{"type":"object","properties":{"label":{"type":"string"},"colour":{"type":"string","enum":["blue","blue_inverted","cyan","cyan_inverted","gray","gray_inverted","green","green_inverted","orange","orange_inverted","pink","pink_inverted","purple","purple_inverted","red","red_inverted","yellow","yellow_inverted"]},"logo_url":{"type":"string","format":"uri"},"version":{"type":"integer"},"version_name":{"type":"string"},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"rate_limit_duration":{"type":"integer"},"system_type_id":{"type":"string"},"protocol":{"type":"string","enum":["HTTP","FTP","SFTP","FTPS","S3","MySQL","PGSQL","SQLSRV"]},"company_id":{"type":"string"},"date_format":{"type":"string"},"help_link":{"type":"string","nullable":true},"name":{"type":"string"}}}}}}
```

## The PatchworksDuplicateFlowDuplicateFlowRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"PatchworksDuplicateFlowDuplicateFlowRequest":{"type":"object","properties":{"flow_version_id":{"type":"string"},"from_company_id":{"type":"string"},"to_company_id":{"type":"string"}},"required":["flow_version_id","from_company_id","to_company_id"]}}}}
```

## The PatchworksListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"PatchworksListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Patchworks"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Patchworks":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"label":{"type":"string"},"colour":{"type":"string","enum":["blue","blue_inverted","cyan","cyan_inverted","gray","gray_inverted","green","green_inverted","orange","orange_inverted","pink","pink_inverted","purple","purple_inverted","red","red_inverted","yellow","yellow_inverted"]},"logo_url":{"type":"string"},"version":{"type":"integer"},"version_name":{"type":"string"},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"rate_limit_duration":{"type":"integer"},"system_type_id":{"type":"string"},"protocol":{"type":"string","enum":["HTTP","FTP","SFTP","FTPS","S3","MySQL","PGSQL","SQLSRV"]},"company_id":{"type":"string"},"date_format":{"type":"string"},"help_link":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The PatchworksResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"PatchworksResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Patchworks"}}},"Patchworks":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"label":{"type":"string"},"colour":{"type":"string","enum":["blue","blue_inverted","cyan","cyan_inverted","gray","gray_inverted","green","green_inverted","orange","orange_inverted","pink","pink_inverted","purple","purple_inverted","red","red_inverted","yellow","yellow_inverted"]},"logo_url":{"type":"string"},"version":{"type":"integer"},"version_name":{"type":"string"},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"rate_limit_duration":{"type":"integer"},"system_type_id":{"type":"string"},"protocol":{"type":"string","enum":["HTTP","FTP","SFTP","FTPS","S3","MySQL","PGSQL","SQLSRV"]},"company_id":{"type":"string"},"date_format":{"type":"string"},"help_link":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}}}}
```

## The PayloadMetadata object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"PayloadMetadata":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"flow_version_id":{"type":"integer"},"flow_step_id":{"type":"integer"},"flow_run_id":{"type":"integer"},"payload_store_reference":{"type":"string"},"payload_size":{"type":"string"},"dropped":{"type":"string"}}}}}}
```

## The PayloadMetadataListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"PayloadMetadataListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PayloadMetadata"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"PayloadMetadata":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"flow_version_id":{"type":"integer"},"flow_step_id":{"type":"integer"},"flow_run_id":{"type":"integer"},"payload_store_reference":{"type":"string"},"payload_size":{"type":"string"},"dropped":{"type":"string"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The PayloadMetadataResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"PayloadMetadataResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PayloadMetadata"}}},"PayloadMetadata":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"flow_version_id":{"type":"integer"},"flow_step_id":{"type":"integer"},"flow_run_id":{"type":"integer"},"payload_store_reference":{"type":"string"},"payload_size":{"type":"string"},"dropped":{"type":"string"}}}}}}
```

## The RequestOptions object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"RequestOptions":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"type":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"requestable_type":{"type":"string"},"requestable_id":{"type":"integer"},"configurable":{"type":"string"},"locked":{"type":"string"},"required":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"alias":{"type":"string"}}}}}}
```

## The RequestOptionsStoreRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"RequestOptionsStoreRequest":{"type":"object","properties":{"type":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"requestable_type":{"type":"string"},"requestable_id":{"type":"integer"},"configurable":{"type":"string","nullable":true},"locked":{"type":"string","nullable":true},"required":{"type":"string","nullable":true}},"required":["key","requestable_id","requestable_type","type","value"]}}}}
```

## The RequestOptionsUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"RequestOptionsUpdateRequest":{"type":"object","properties":{"type":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The RequestOptionsListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"RequestOptionsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RequestOptions"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"RequestOptions":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"type":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"requestable_type":{"type":"string"},"requestable_id":{"type":"integer"},"configurable":{"type":"string"},"locked":{"type":"string"},"required":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"alias":{"type":"string"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The RequestOptionsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"RequestOptionsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RequestOptions"}}},"RequestOptions":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"type":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"requestable_type":{"type":"string"},"requestable_id":{"type":"integer"},"configurable":{"type":"string"},"locked":{"type":"string"},"required":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"alias":{"type":"string"}}}}}}
```

## The ScheduledFlows object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ScheduledFlows":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"flow_version_id":{"type":"object"},"flow_version":{"type":"object"},"virtual_environment_version_id":{"type":"object"},"virtual_environment_version":{"type":"object"},"payload_metadata_id":{"type":"object"},"payload_metadata":{"type":"object"},"trigger":{"type":"string","enum":["API","Manual","Router","Webhook","Schedule","Shape","Retry","Event","Callback"]},"status":{"type":"object","enum":["Draft","Inactive","Deployed"]},"flow":{"type":"object"}}}}}}
```

## The ScheduledFlowsListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ScheduledFlowsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ScheduledFlows"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"ScheduledFlows":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"flow_version_id":{"type":"object"},"flow_version":{"type":"object"},"virtual_environment_version_id":{"type":"object"},"virtual_environment_version":{"type":"object"},"payload_metadata_id":{"type":"object"},"payload_metadata":{"type":"object"},"trigger":{"type":"string","enum":["API","Manual","Router","Webhook","Schedule","Shape","Retry","Event","Callback"]},"status":{"type":"object","enum":["Draft","Inactive","Deployed"]},"flow":{"type":"object"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The ScriptTemplates object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ScriptTemplates":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"description":{"type":"string"},"language":{"type":"object"},"company_id":{"type":"object"},"canonical_key":{"type":"object"},"content":{"type":"object"},"marketplace_company_id":{"type":"object"},"marketplace_company":{"type":"object"},"tenant_script_version_id":{"type":"integer"}}}}}}
```

## The ScriptTemplatesListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ScriptTemplatesListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ScriptTemplates"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"ScriptTemplates":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"description":{"type":"string"},"language":{"type":"object"},"company_id":{"type":"object"},"canonical_key":{"type":"object"},"content":{"type":"object"},"marketplace_company_id":{"type":"object"},"marketplace_company":{"type":"object"},"tenant_script_version_id":{"type":"integer"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The ScriptTemplatesResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ScriptTemplatesResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ScriptTemplates"}}},"ScriptTemplates":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"description":{"type":"string"},"language":{"type":"object"},"company_id":{"type":"object"},"canonical_key":{"type":"object"},"content":{"type":"object"},"marketplace_company_id":{"type":"object"},"marketplace_company":{"type":"object"},"tenant_script_version_id":{"type":"integer"}}}}}}
```

## The ScriptVersionMetrics object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ScriptVersionMetrics":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}}}}
```

## The ScriptVersionMetricsListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ScriptVersionMetricsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ScriptVersionMetrics"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"ScriptVersionMetrics":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The ScriptVersions object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ScriptVersions":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"script_id":{"type":"integer"},"name":{"type":"string"},"version":{"type":"integer"},"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"deployment_failure_reason":{"type":"string"},"last_invoked_on":{"type":"string"},"deployed_at":{"type":"string","format":"date-time"},"deployment_failed_at":{"type":"string","format":"date-time"},"deploying":{"type":"string"},"content":{"type":"object"},"script":{"type":"object"}}}}}}
```

## The ScriptVersionsInvokeInvokeRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ScriptVersionsInvokeInvokeRequest":{"type":"object","properties":{"variables":{"type":"string"},"payload":{"type":"string"},"flow":{"type":"string","properties":{"variables":{"type":"string"}}}}}}}}
```

## The ScriptVersionsScriptUploadUploadRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ScriptVersionsScriptUploadUploadRequest":{"type":"object","properties":{"private":{"type":"string"}}}}}}
```

## The ScriptVersionsListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ScriptVersionsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ScriptVersions"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"ScriptVersions":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"script_id":{"type":"integer"},"name":{"type":"string"},"version":{"type":"integer"},"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"deployment_failure_reason":{"type":"string"},"last_invoked_on":{"type":"string"},"deployed_at":{"type":"string","format":"date-time"},"deployment_failed_at":{"type":"string","format":"date-time"},"deploying":{"type":"string"},"content":{"type":"object"},"script":{"type":"object"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The ScriptVersionsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ScriptVersionsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ScriptVersions"}}},"ScriptVersions":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"script_id":{"type":"integer"},"name":{"type":"string"},"version":{"type":"integer"},"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"deployment_failure_reason":{"type":"string"},"last_invoked_on":{"type":"string"},"deployed_at":{"type":"string","format":"date-time"},"deployment_failed_at":{"type":"string","format":"date-time"},"deploying":{"type":"string"},"content":{"type":"object"},"script":{"type":"object"}}}}}}
```

## The Scripts object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"Scripts":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"script_template_id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string","items":{"type":"object"}},"language":{"type":"string","items":{"type":"object"}},"created_at":{"type":"string"},"updated_at":{"type":"string"},"script_id":{"type":"integer"},"version":{"type":"string"},"deployed_at":{"type":"string"},"deployment_failed_at":{"type":"string"},"deploying":{"type":"string"},"deployment_failure_reason":{"type":"string"},"content":{"type":"string"},"ai_created":{"type":"string","items":{"type":"object"}},"value":{"type":"string"},"versions":{"type":"array","items":{"type":"object"}},"latest_version":{"type":"object"}}}}}}
```

## The ScriptsStoreScriptVersionsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ScriptsStoreScriptVersionsRequest":{"type":"object","properties":{"content":{"type":"string","minLength":1}},"required":["content"]}}}}
```

## The ScriptsUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ScriptsUpdateRequest":{"type":"object","properties":{"description":{"type":"string","maxLength":255,"nullable":true},"language":{"type":"string"},"value":{"type":"string","minLength":1},"name":{"type":"string","maxLength":255}}}}}}
```

## The ScriptsStoreRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ScriptsStoreRequest":{"type":"object","properties":{"description":{"type":"string","maxLength":255,"nullable":true},"language":{"type":"string"},"ai_created":{"type":"string","nullable":true},"name":{"type":"string","maxLength":255}},"required":["language","name"]}}}}
```

## The ScriptsListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ScriptsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Scripts"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Scripts":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"script_template_id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string","items":{"type":"object"}},"language":{"type":"string","items":{"type":"object"}},"created_at":{"type":"string"},"updated_at":{"type":"string"},"script_id":{"type":"integer"},"version":{"type":"string"},"deployed_at":{"type":"string"},"deployment_failed_at":{"type":"string"},"deploying":{"type":"string"},"deployment_failure_reason":{"type":"string"},"content":{"type":"string"},"ai_created":{"type":"string","items":{"type":"object"}},"value":{"type":"string"},"versions":{"type":"array","items":{"type":"object"}},"latest_version":{"type":"object"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The ScriptsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"ScriptsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Scripts"}}},"Scripts":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"script_template_id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string","items":{"type":"object"}},"language":{"type":"string","items":{"type":"object"}},"created_at":{"type":"string"},"updated_at":{"type":"string"},"script_id":{"type":"integer"},"version":{"type":"string"},"deployed_at":{"type":"string"},"deployment_failed_at":{"type":"string"},"deploying":{"type":"string"},"deployment_failure_reason":{"type":"string"},"content":{"type":"string"},"ai_created":{"type":"string","items":{"type":"object"}},"value":{"type":"string"},"versions":{"type":"array","items":{"type":"object"}},"latest_version":{"type":"object"}}}}}}
```

## The SystemTemplates object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"SystemTemplates":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"label":{"type":"string"},"colour":{"type":"string","enum":["blue","blue_inverted","cyan","cyan_inverted","gray","gray_inverted","green","green_inverted","orange","orange_inverted","pink","pink_inverted","purple","purple_inverted","red","red_inverted","yellow","yellow_inverted"]},"logo_url":{"type":"string"},"version":{"type":"integer"},"version_name":{"type":"string"},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"protocol":{"type":"object","enum":["HTTP","FTP","SFTP","FTPS","S3","MySQL","PGSQL","SQLSRV"]},"rate_limit_duration":{"type":"object"},"system_type_id":{"type":"object"},"system_type":{"type":"object","enum":["Accounting","CRM","eCommerce","ERP","Marketplaces","Other","PIM","POS","3PL","WMS","Database"]},"date_format":{"type":"string"},"canonical_key":{"type":"object"},"company_id":{"type":"object"},"public_company_id":{"type":"object"},"company":{"type":"object"},"public_company":{"type":"object"},"logo":{"type":"object"},"instances":{"type":"array","items":{"type":"object"}},"authentication_implementation_templates":{"type":"array","items":{"type":"object"}},"marketplace_company_id":{"type":"object"},"marketplace_company":{"type":"object"},"help_link":{"type":"string"}}}}}}
```

## The SystemTemplatesInstallRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"SystemTemplatesInstallRequest":{"type":"object","properties":{"overwrite":{"type":"string"},"system_id":{"type":"integer"},"platform_app_key":{"type":"string"}}}}}}
```

## The SystemTemplatesListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"SystemTemplatesListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SystemTemplates"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"SystemTemplates":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"label":{"type":"string"},"colour":{"type":"string","enum":["blue","blue_inverted","cyan","cyan_inverted","gray","gray_inverted","green","green_inverted","orange","orange_inverted","pink","pink_inverted","purple","purple_inverted","red","red_inverted","yellow","yellow_inverted"]},"logo_url":{"type":"string"},"version":{"type":"integer"},"version_name":{"type":"string"},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"protocol":{"type":"object","enum":["HTTP","FTP","SFTP","FTPS","S3","MySQL","PGSQL","SQLSRV"]},"rate_limit_duration":{"type":"object"},"system_type_id":{"type":"object"},"system_type":{"type":"object","enum":["Accounting","CRM","eCommerce","ERP","Marketplaces","Other","PIM","POS","3PL","WMS","Database"]},"date_format":{"type":"string"},"canonical_key":{"type":"object"},"company_id":{"type":"object"},"public_company_id":{"type":"object"},"company":{"type":"object"},"public_company":{"type":"object"},"logo":{"type":"object"},"instances":{"type":"array","items":{"type":"object"}},"authentication_implementation_templates":{"type":"array","items":{"type":"object"}},"marketplace_company_id":{"type":"object"},"marketplace_company":{"type":"object"},"help_link":{"type":"string"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The SystemTemplatesResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"SystemTemplatesResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SystemTemplates"}}},"SystemTemplates":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"label":{"type":"string"},"colour":{"type":"string","enum":["blue","blue_inverted","cyan","cyan_inverted","gray","gray_inverted","green","green_inverted","orange","orange_inverted","pink","pink_inverted","purple","purple_inverted","red","red_inverted","yellow","yellow_inverted"]},"logo_url":{"type":"string"},"version":{"type":"integer"},"version_name":{"type":"string"},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"protocol":{"type":"object","enum":["HTTP","FTP","SFTP","FTPS","S3","MySQL","PGSQL","SQLSRV"]},"rate_limit_duration":{"type":"object"},"system_type_id":{"type":"object"},"system_type":{"type":"object","enum":["Accounting","CRM","eCommerce","ERP","Marketplaces","Other","PIM","POS","3PL","WMS","Database"]},"date_format":{"type":"string"},"canonical_key":{"type":"object"},"company_id":{"type":"object"},"public_company_id":{"type":"object"},"company":{"type":"object"},"public_company":{"type":"object"},"logo":{"type":"object"},"instances":{"type":"array","items":{"type":"object"}},"authentication_implementation_templates":{"type":"array","items":{"type":"object"}},"marketplace_company_id":{"type":"object"},"marketplace_company":{"type":"object"},"help_link":{"type":"string"}}}}}}
```

## The Systems object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"Systems":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"name":{"type":"string"},"entity_type_id":{"type":"integer"},"direction":{"type":"string","enum":["Send","Receive"]},"http_method":{"type":"string","enum":["CONNECT","DELETE","GET","HEAD","OPTIONS","PATCH","POST","PUT","TRACE"]},"label":{"type":"string"},"colour":{"type":"string","enum":["blue","blue_inverted","cyan","cyan_inverted","gray","gray_inverted","green","green_inverted","orange","orange_inverted","pink","pink_inverted","purple","purple_inverted","red","red_inverted","yellow","yellow_inverted"]},"system_template_id":{"type":"integer"},"version":{"type":"string"},"version_name":{"type":"string"},"system_type_id":{"type":"integer"},"protocol":{"type":"string","enum":["HTTP","FTP","SFTP","FTPS","S3","MySQL","PGSQL","SQLSRV"]},"date_format":{"type":"string"},"help_link":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"rate_limit_duration":{"type":"string"},"endpoint":{"type":"string"},"method":{"type":"string"},"data_type":{"type":"string","enum":["csv","json","txt","xml"]},"body_format":{"type":"string","enum":["none","form-data","raw","text"]},"additional_endpoint_1":{"type":"string"},"additional_endpoint_2":{"type":"string"},"timeout":{"type":"integer"},"authentication_type_id":{"type":"string"},"returns_multiple_records":{"type":"string"},"pagination_method":{"type":"string","enum":["Custom relative URI","Link Header","Next page token","Next Page URL","Page number parameter","Limit offset","default","PeopleVox","NetSuite SOAP","GraphQL Cursor","Database limit offset","Script"]},"schema":{"type":"string"},"endpoint_template_id":{"type":"integer"},"data_path":{"type":"string"},"raw_body":{"type":"string"},"deprecated_at":{"type":"string"},"disable_header_addition":{"type":"string"},"response_encoding":{"type":"string","enum":["base64","none"]},"key":{"type":"string"},"value":{"type":"string"},"secret":{"type":"string"},"logo":{"type":"string","items":{"type":"object"}},"pre_script_version_id":{"type":"string"},"post_script_version_id":{"type":"string"},"canonical_key":{"type":"array","items":{"type":"object"}},"connectors":{"type":"array","items":{"type":"object"}},"system_type":{"type":"object","enum":["Accounting","CRM","eCommerce","ERP","Marketplaces","Other","PIM","POS","3PL","WMS","Database"]},"system_template":{"type":"array","items":{"type":"object"}},"authentication_implementations":{"type":"array","items":{"type":"object"}},"authentication_implementations_count":{"type":"array","items":{"type":"object"}},"endpoints":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"updatable":{"type":"string"},"modified":{"type":"string"},"is_deployed":{"type":"boolean"}}}}}}
```

## The SystemsStoreAuthenticationImplementationsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"SystemsStoreAuthenticationImplementationsRequest":{"type":"object","properties":{"endpoint":{"type":"string","nullable":true},"method":{"type":"string"},"data_type":{"type":"string","nullable":true,"enum":["csv","json","txt","xml"]},"body_format":{"type":"string","nullable":true,"enum":["none","form-data","raw","text"]},"additional_endpoint_1":{"type":"string","nullable":true},"additional_endpoint_2":{"type":"string","nullable":true},"timeout":{"type":"integer","minimum":1,"maximum":65535},"authentication_type_id":{"type":"string"},"help_link":{"type":"string","nullable":true},"name":{"type":"string"}},"required":["authentication_type_id","endpoint","method","name"]}}}}
```

## The SystemsUpdateAuthenticationImplementationsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"SystemsUpdateAuthenticationImplementationsRequest":{"type":"object","properties":{"endpoint":{"type":"string","nullable":true},"method":{"type":"string"},"data_type":{"type":"string","nullable":true,"enum":["csv","json","txt","xml"]},"body_format":{"type":"string","nullable":true,"enum":["none","form-data","raw","text"]},"additional_endpoint_1":{"type":"string","nullable":true},"additional_endpoint_2":{"type":"string","nullable":true},"timeout":{"type":"integer","minimum":1,"maximum":65535},"authentication_type_id":{"type":"string"},"pre_script_version_id":{"type":"string","nullable":true},"post_script_version_id":{"type":"string","nullable":true},"help_link":{"type":"string","nullable":true},"name":{"type":"string"}}}}}}
```

## The SystemsStoreEndpointsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"SystemsStoreEndpointsRequest":{"type":"object","properties":{"entity_type_id":{"type":"integer","nullable":true},"endpoint":{"type":"string"},"direction":{"type":"string","enum":["Send","Receive"]},"returns_multiple_records":{"type":"string"},"http_method":{"type":"string","enum":["CONNECT","DELETE","GET","HEAD","OPTIONS","PATCH","POST","PUT","TRACE"]},"data_type":{"type":"string","enum":["csv","json","txt","xml"]},"pagination_method":{"type":"string","nullable":true,"enum":["Custom relative URI","Link Header","Next page token","Next Page URL","Page number parameter","Limit offset","default","PeopleVox","NetSuite SOAP","GraphQL Cursor","Database limit offset","Script"]},"schema":{"type":"string","nullable":true},"endpoint_template_id":{"type":"integer"},"data_path":{"type":"string","nullable":true},"body_format":{"type":"string","enum":["none","form-data","raw","text"]},"raw_body":{"type":"string","nullable":true},"deprecated_at":{"type":"string","format":"date-time","nullable":true},"help_link":{"type":"string","nullable":true},"disable_header_addition":{"type":"string","nullable":true},"response_encoding":{"type":"string","nullable":true,"enum":["base64","none"]},"name":{"type":"string","pattern":"^[a-zA-Z0-9 \\-&\\+_]+$"}},"required":["data_type","direction","endpoint","http_method","name","returns_multiple_records"]}}}}
```

## The SystemsUpdateEndpointsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"SystemsUpdateEndpointsRequest":{"type":"object","properties":{"entity_type_id":{"type":"integer","nullable":true},"endpoint":{"type":"string"},"direction":{"type":"string","enum":["Send","Receive"]},"returns_multiple_records":{"type":"string"},"http_method":{"type":"string","enum":["CONNECT","DELETE","GET","HEAD","OPTIONS","PATCH","POST","PUT","TRACE"]},"data_type":{"type":"string","enum":["csv","json","txt","xml"]},"pagination_method":{"type":"string","nullable":true,"enum":["Custom relative URI","Link Header","Next page token","Next Page URL","Page number parameter","Limit offset","default","PeopleVox","NetSuite SOAP","GraphQL Cursor","Database limit offset","Script"]},"schema":{"type":"string","nullable":true},"endpoint_template_id":{"type":"integer"},"data_path":{"type":"string","nullable":true},"body_format":{"type":"string","enum":["none","form-data","raw","text"]},"raw_body":{"type":"string","nullable":true},"deprecated_at":{"type":"string","nullable":true},"help_link":{"type":"string","nullable":true},"pre_script_version_id":{"type":"string","nullable":true},"post_script_version_id":{"type":"string","nullable":true},"disable_header_addition":{"type":"string"},"response_encoding":{"type":"string","nullable":true,"enum":["base64","none"]},"name":{"type":"string","pattern":"^[a-zA-Z0-9 \\-&\\+_]+$"}}}}}}
```

## The SystemsWsdlIngestIngestWsdlRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"SystemsWsdlIngestIngestWsdlRequest":{"type":"object","properties":{"wsdl_url":{"type":"string"},"update_existing":{"type":"string"},"wsdl_file":{"type":"string"}},"required":["update_existing"]}}}}
```

## The SystemsStoreVariablesRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"SystemsStoreVariablesRequest":{"type":"object","properties":{"label":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"secret":{"type":"string"},"pivot":{"type":"object","properties":{"alias":{"type":"string"},"configurable":{"type":"string"},"required":{"type":"string"},"advanced":{"type":"string"}}}},"required":["label","key"]}}}}
```

## The SystemsUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"SystemsUpdateRequest":{"type":"object","properties":{"version_name":{"type":"string"},"label":{"type":"string"},"colour":{"type":"string","enum":["blue","blue_inverted","cyan","cyan_inverted","gray","gray_inverted","green","green_inverted","orange","orange_inverted","pink","pink_inverted","purple","purple_inverted","red","red_inverted","yellow","yellow_inverted"]},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"rate_limit_duration":{"type":"integer"},"system_type_id":{"type":"string"},"protocol":{"type":"string","enum":["HTTP","FTP","SFTP","FTPS","S3","MySQL","PGSQL","SQLSRV"]},"system_template_id":{"type":"integer"},"logo":{"type":"string"},"date_format":{"type":"string"},"help_link":{"type":"string","nullable":true},"name":{"type":"string"}}}}}}
```

## The SystemsExportExportRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"SystemsExportExportRequest":{"type":"object","properties":{"system_id":{"type":"integer"}},"required":["system_id"]}}}}
```

## The SystemsImportImportRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"SystemsImportImportRequest":{"type":"object","properties":{"system":{"type":"string"},"metadata":{"type":"string"},"as_marketplace":{"type":"string"}},"required":["system","metadata"]}}}}
```

## The SystemsStoreRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"SystemsStoreRequest":{"type":"object","properties":{"version_name":{"type":"string"},"label":{"type":"string"},"colour":{"type":"string","enum":["blue","blue_inverted","cyan","cyan_inverted","gray","gray_inverted","green","green_inverted","orange","orange_inverted","pink","pink_inverted","purple","purple_inverted","red","red_inverted","yellow","yellow_inverted"]},"logo":{"type":"string"},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"rate_limit_duration":{"type":"integer"},"system_type_id":{"type":"string"},"protocol":{"type":"string","enum":["HTTP","FTP","SFTP","FTPS","S3","MySQL","PGSQL","SQLSRV"]},"system_template_id":{"type":"integer"},"date_format":{"type":"string"},"help_link":{"type":"string","nullable":true},"name":{"type":"string"}},"required":["colour","date_format","label","logo","name","protocol","rate_limit_duration","rate_limit_unit","system_type_id","version_name"]}}}}
```

## The SystemsPostmanImportImportPostmanRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"SystemsPostmanImportImportPostmanRequest":{"type":"object","properties":{"collection_url":{"type":"string"},"collection_file":{"type":"string"},"precog":{"type":"string"}}}}}}
```

## The SystemsUploadUploadRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"SystemsUploadUploadRequest":{"type":"object","properties":{"private":{"type":"string"}}}}}}
```

## The SystemsListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"SystemsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Systems"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Systems":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"name":{"type":"string"},"entity_type_id":{"type":"integer"},"direction":{"type":"string","enum":["Send","Receive"]},"http_method":{"type":"string","enum":["CONNECT","DELETE","GET","HEAD","OPTIONS","PATCH","POST","PUT","TRACE"]},"label":{"type":"string"},"colour":{"type":"string","enum":["blue","blue_inverted","cyan","cyan_inverted","gray","gray_inverted","green","green_inverted","orange","orange_inverted","pink","pink_inverted","purple","purple_inverted","red","red_inverted","yellow","yellow_inverted"]},"system_template_id":{"type":"integer"},"version":{"type":"string"},"version_name":{"type":"string"},"system_type_id":{"type":"integer"},"protocol":{"type":"string","enum":["HTTP","FTP","SFTP","FTPS","S3","MySQL","PGSQL","SQLSRV"]},"date_format":{"type":"string"},"help_link":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"rate_limit_duration":{"type":"string"},"endpoint":{"type":"string"},"method":{"type":"string"},"data_type":{"type":"string","enum":["csv","json","txt","xml"]},"body_format":{"type":"string","enum":["none","form-data","raw","text"]},"additional_endpoint_1":{"type":"string"},"additional_endpoint_2":{"type":"string"},"timeout":{"type":"integer"},"authentication_type_id":{"type":"string"},"returns_multiple_records":{"type":"string"},"pagination_method":{"type":"string","enum":["Custom relative URI","Link Header","Next page token","Next Page URL","Page number parameter","Limit offset","default","PeopleVox","NetSuite SOAP","GraphQL Cursor","Database limit offset","Script"]},"schema":{"type":"string"},"endpoint_template_id":{"type":"integer"},"data_path":{"type":"string"},"raw_body":{"type":"string"},"deprecated_at":{"type":"string"},"disable_header_addition":{"type":"string"},"response_encoding":{"type":"string","enum":["base64","none"]},"key":{"type":"string"},"value":{"type":"string"},"secret":{"type":"string"},"logo":{"type":"string","items":{"type":"object"}},"pre_script_version_id":{"type":"string"},"post_script_version_id":{"type":"string"},"canonical_key":{"type":"array","items":{"type":"object"}},"connectors":{"type":"array","items":{"type":"object"}},"system_type":{"type":"object","enum":["Accounting","CRM","eCommerce","ERP","Marketplaces","Other","PIM","POS","3PL","WMS","Database"]},"system_template":{"type":"array","items":{"type":"object"}},"authentication_implementations":{"type":"array","items":{"type":"object"}},"authentication_implementations_count":{"type":"array","items":{"type":"object"}},"endpoints":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"updatable":{"type":"string"},"modified":{"type":"string"},"is_deployed":{"type":"boolean"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The SystemsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"SystemsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Systems"}}},"Systems":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"name":{"type":"string"},"entity_type_id":{"type":"integer"},"direction":{"type":"string","enum":["Send","Receive"]},"http_method":{"type":"string","enum":["CONNECT","DELETE","GET","HEAD","OPTIONS","PATCH","POST","PUT","TRACE"]},"label":{"type":"string"},"colour":{"type":"string","enum":["blue","blue_inverted","cyan","cyan_inverted","gray","gray_inverted","green","green_inverted","orange","orange_inverted","pink","pink_inverted","purple","purple_inverted","red","red_inverted","yellow","yellow_inverted"]},"system_template_id":{"type":"integer"},"version":{"type":"string"},"version_name":{"type":"string"},"system_type_id":{"type":"integer"},"protocol":{"type":"string","enum":["HTTP","FTP","SFTP","FTPS","S3","MySQL","PGSQL","SQLSRV"]},"date_format":{"type":"string"},"help_link":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"rate_limit_duration":{"type":"string"},"endpoint":{"type":"string"},"method":{"type":"string"},"data_type":{"type":"string","enum":["csv","json","txt","xml"]},"body_format":{"type":"string","enum":["none","form-data","raw","text"]},"additional_endpoint_1":{"type":"string"},"additional_endpoint_2":{"type":"string"},"timeout":{"type":"integer"},"authentication_type_id":{"type":"string"},"returns_multiple_records":{"type":"string"},"pagination_method":{"type":"string","enum":["Custom relative URI","Link Header","Next page token","Next Page URL","Page number parameter","Limit offset","default","PeopleVox","NetSuite SOAP","GraphQL Cursor","Database limit offset","Script"]},"schema":{"type":"string"},"endpoint_template_id":{"type":"integer"},"data_path":{"type":"string"},"raw_body":{"type":"string"},"deprecated_at":{"type":"string"},"disable_header_addition":{"type":"string"},"response_encoding":{"type":"string","enum":["base64","none"]},"key":{"type":"string"},"value":{"type":"string"},"secret":{"type":"string"},"logo":{"type":"string","items":{"type":"object"}},"pre_script_version_id":{"type":"string"},"post_script_version_id":{"type":"string"},"canonical_key":{"type":"array","items":{"type":"object"}},"connectors":{"type":"array","items":{"type":"object"}},"system_type":{"type":"object","enum":["Accounting","CRM","eCommerce","ERP","Marketplaces","Other","PIM","POS","3PL","WMS","Database"]},"system_template":{"type":"array","items":{"type":"object"}},"authentication_implementations":{"type":"array","items":{"type":"object"}},"authentication_implementations_count":{"type":"array","items":{"type":"object"}},"endpoints":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"updatable":{"type":"string"},"modified":{"type":"string"},"is_deployed":{"type":"boolean"}}}}}}
```

## The TrackedData object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"TrackedData":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"flow_id":{"type":"integer"},"flow_run_id":{"type":"integer"},"step_id":{"type":"integer"},"entity_type_id":{"type":"integer"},"tracked_data_store_reference":{"type":"string"},"value":{"type":"string"},"direction":{"type":"string","enum":["Send","Receive"]},"sent_count":{"type":"object"},"received_count":{"type":"object"},"success":{"type":"object"},"flow":{"type":"object"},"flow_step":{"type":"object"},"flow_run":{"type":"object"},"entity_type":{"type":"object"}}}}}}
```

## The TrackedDataListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"TrackedDataListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TrackedData"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"TrackedData":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"flow_id":{"type":"integer"},"flow_run_id":{"type":"integer"},"step_id":{"type":"integer"},"entity_type_id":{"type":"integer"},"tracked_data_store_reference":{"type":"string"},"value":{"type":"string"},"direction":{"type":"string","enum":["Send","Receive"]},"sent_count":{"type":"object"},"received_count":{"type":"object"},"success":{"type":"object"},"flow":{"type":"object"},"flow_step":{"type":"object"},"flow_run":{"type":"object"},"entity_type":{"type":"object"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The Transforms object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"Transforms":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}}}}
```

## The TransformsListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"TransformsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Transforms"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Transforms":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The Variables object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"Variables":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"label":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"secret":{"type":"string"},"locked":{"type":"string"},"configurable":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"modified":{"type":"string"},"pivot":{"type":"string"},"required":{"type":"boolean"},"advanced":{"type":"boolean"},"alias":{"type":"string"}}}}}}
```

## The VariablesStoreRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"VariablesStoreRequest":{"type":"object","properties":{"label":{"type":"string"},"key":{"type":"string"},"value":{"type":"string","nullable":true},"secret":{"type":"string"},"locked":{"type":"string"}},"required":["key","label"]}}}}
```

## The VariablesUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"VariablesUpdateRequest":{"type":"object","properties":{"label":{"type":"string"},"key":{"type":"string"},"value":{"type":"string","nullable":true},"configurable":{"type":"string"}}}}}}
```

## The VariablesListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"VariablesListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Variables"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Variables":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"label":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"secret":{"type":"string"},"locked":{"type":"string"},"configurable":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"modified":{"type":"string"},"pivot":{"type":"string"},"required":{"type":"boolean"},"advanced":{"type":"boolean"},"alias":{"type":"string"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The VariablesResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"VariablesResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Variables"}}},"Variables":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"label":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"secret":{"type":"string"},"locked":{"type":"string"},"configurable":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"modified":{"type":"string"},"pivot":{"type":"string"},"required":{"type":"boolean"},"advanced":{"type":"boolean"},"alias":{"type":"string"}}}}}}
```

## The VirtualEnvironmentVersions object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"VirtualEnvironmentVersions":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"flow_id":{"type":"string"},"priority":{"type":"integer"},"model_type":{"type":"string"},"original_model_id":{"type":"string"},"replacement_model_id":{"type":"string"},"type":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"fallback":{"type":"string"},"date_format":{"type":"string"},"secret":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"version":{"type":"object"},"virtual_environment_id":{"type":"object"},"virtual_environment":{"type":"object"},"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"deployed_at":{"type":"array","items":{"type":"object"},"format":"date-time"},"deployed_by":{"type":"array","items":{"type":"object"}},"notes":{"type":"array","items":{"type":"object"}},"manifests":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"counts":{"type":"string"},"user_id":{"type":"object"},"user":{"type":"object"}}}}}}
```

## The VirtualEnvironmentVersionsStoreFlowPrioritiesRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"VirtualEnvironmentVersionsStoreFlowPrioritiesRequest":{"type":"object","properties":{"flow_id":{"type":"string"},"priority":{"type":"integer"},"notes":{"type":"string"}},"required":["flow_id","priority"]}}}}
```

## The VirtualEnvironmentVersionsUpdateFlowPrioritiesRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"VirtualEnvironmentVersionsUpdateFlowPrioritiesRequest":{"type":"object","properties":{"flow_id":{"type":"string"},"priority":{"type":"integer"},"notes":{"type":"string"}}}}}}
```

## The VirtualEnvironmentVersionsStoreManifestsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"VirtualEnvironmentVersionsStoreManifestsRequest":{"type":"object","properties":{"model_type":{"type":"string"},"original_model_id":{"type":"string"},"replacement_model_id":{"type":"string"}},"required":["model_type","original_model_id","replacement_model_id"]}}}}
```

## The VirtualEnvironmentVersionsUpdateManifestsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"VirtualEnvironmentVersionsUpdateManifestsRequest":{"type":"object","properties":{"model_type":{"type":"string"},"original_model_id":{"type":"string"},"replacement_model_id":{"type":"string"}}}}}}
```

## The VirtualEnvironmentVersionsStoreVariablesRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"VirtualEnvironmentVersionsStoreVariablesRequest":{"type":"object","properties":{"type":{"type":"string"},"key":{"type":"string","minLength":1},"value":{"type":"string","maximum":1024},"fallback":{"type":"string","maxLength":1024,"nullable":true},"date_format":{"type":"string","nullable":true},"secret":{"type":"string"}},"required":["key","type"]}}}}
```

## The VirtualEnvironmentVersionsUpdateVariablesRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"VirtualEnvironmentVersionsUpdateVariablesRequest":{"type":"object","properties":{"type":{"type":"string"},"key":{"type":"string","minLength":1},"value":{"type":"string","maximum":1024},"fallback":{"type":"string","maxLength":1024,"nullable":true},"date_format":{"type":"string","nullable":true},"secret":{"type":"string"}}}}}}
```

## The VirtualEnvironmentVersionsListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"VirtualEnvironmentVersionsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VirtualEnvironmentVersions"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"VirtualEnvironmentVersions":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"flow_id":{"type":"string"},"priority":{"type":"integer"},"model_type":{"type":"string"},"original_model_id":{"type":"string"},"replacement_model_id":{"type":"string"},"type":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"fallback":{"type":"string"},"date_format":{"type":"string"},"secret":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"version":{"type":"object"},"virtual_environment_id":{"type":"object"},"virtual_environment":{"type":"object"},"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"deployed_at":{"type":"array","items":{"type":"object"},"format":"date-time"},"deployed_by":{"type":"array","items":{"type":"object"}},"notes":{"type":"array","items":{"type":"object"}},"manifests":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"counts":{"type":"string"},"user_id":{"type":"object"},"user":{"type":"object"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The VirtualEnvironmentVersionsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"VirtualEnvironmentVersionsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/VirtualEnvironmentVersions"}}},"VirtualEnvironmentVersions":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"flow_id":{"type":"string"},"priority":{"type":"integer"},"model_type":{"type":"string"},"original_model_id":{"type":"string"},"replacement_model_id":{"type":"string"},"type":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"fallback":{"type":"string"},"date_format":{"type":"string"},"secret":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"version":{"type":"object"},"virtual_environment_id":{"type":"object"},"virtual_environment":{"type":"object"},"status":{"type":"string","enum":["Draft","Inactive","Deployed"]},"deployed_at":{"type":"array","items":{"type":"object"},"format":"date-time"},"deployed_by":{"type":"array","items":{"type":"object"}},"notes":{"type":"array","items":{"type":"object"}},"manifests":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"counts":{"type":"string"},"user_id":{"type":"object"},"user":{"type":"object"}}}}}}
```

## The VirtualEnvironments object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"VirtualEnvironments":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"notes":{"type":"string"},"deployed_at":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string"},"name":{"type":"string","items":{"type":"object"}},"description":{"type":"string","items":{"type":"object"}},"type":{"type":"string","items":{"type":"object"}},"deployments":{"type":"array","items":{"type":"object"}},"versions":{"type":"array","items":{"type":"object"}},"versions_count":{"type":"integer"},"first_version":{"type":"string"},"deployed_version":{"type":"string"},"flows":{"type":"string"},"is_deployed":{"type":"boolean"},"deployments_count":{"type":"array","items":{"type":"object"}},"pivot":{"type":"array","items":{"type":"object"}},"package_deployments":{"type":"array","items":{"type":"object"}},"labels":{"type":"array","items":{"type":"object"}}}}}}}
```

## The VirtualEnvironmentsStoreVersionsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"VirtualEnvironmentsStoreVersionsRequest":{"type":"object","properties":{"notes":{"type":"string"}}}}}}
```

## The VirtualEnvironmentsUpdateVersionsRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"VirtualEnvironmentsUpdateVersionsRequest":{"type":"object","properties":{"notes":{"type":"string"}}}}}}
```

## The VirtualEnvironmentsUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"VirtualEnvironmentsUpdateRequest":{"type":"object","properties":{"description":{"type":"string","maxLength":255,"nullable":true},"type":{"type":"string","nullable":true},"name":{"type":"string","maxLength":255},"labels":{"type":"array","properties":{"*":{"type":"object","properties":{"id":{"type":"string"}}}}}},"required":["labels","name"]}}}}
```

## The VirtualEnvironmentsStoreRequest object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"VirtualEnvironmentsStoreRequest":{"type":"object","properties":{"description":{"type":"string","maxLength":255,"nullable":true},"type":{"type":"string","nullable":true},"name":{"type":"string","maxLength":245},"labels":{"type":"array","properties":{"*":{"type":"object","properties":{"id":{"type":"string"}}}}}},"required":["labels","name"]}}}}
```

## The VirtualEnvironmentsListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"VirtualEnvironmentsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VirtualEnvironments"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"VirtualEnvironments":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"notes":{"type":"string"},"deployed_at":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string"},"name":{"type":"string","items":{"type":"object"}},"description":{"type":"string","items":{"type":"object"}},"type":{"type":"string","items":{"type":"object"}},"deployments":{"type":"array","items":{"type":"object"}},"versions":{"type":"array","items":{"type":"object"}},"versions_count":{"type":"integer"},"first_version":{"type":"string"},"deployed_version":{"type":"string"},"flows":{"type":"string"},"is_deployed":{"type":"boolean"},"deployments_count":{"type":"array","items":{"type":"object"}},"pivot":{"type":"array","items":{"type":"object"}},"package_deployments":{"type":"array","items":{"type":"object"}},"labels":{"type":"array","items":{"type":"object"}}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}}
```

## The VirtualEnvironmentsResponse object

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"components":{"schemas":{"VirtualEnvironmentsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/VirtualEnvironments"}}},"VirtualEnvironments":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"notes":{"type":"string"},"deployed_at":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string"},"name":{"type":"string","items":{"type":"object"}},"description":{"type":"string","items":{"type":"object"}},"type":{"type":"string","items":{"type":"object"}},"deployments":{"type":"array","items":{"type":"object"}},"versions":{"type":"array","items":{"type":"object"}},"versions_count":{"type":"integer"},"first_version":{"type":"string"},"deployed_version":{"type":"string"},"flows":{"type":"string"},"is_deployed":{"type":"boolean"},"deployments_count":{"type":"array","items":{"type":"object"}},"pivot":{"type":"array","items":{"type":"object"}},"package_deployments":{"type":"array","items":{"type":"object"}},"labels":{"type":"array","items":{"type":"object"}}}}}}}
```