Systems | API Reference (WIP) | Product documentation

Index

get

Pagination

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

Available Includes

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

logo
logo_count
logoExists
systemType
systemType_count
systemTypeExists
connectors
connectors_count
connectorsExists
connectors.authenticationImplementation
endpoints
endpoints_count
endpointsExists
authenticationImplementations
authenticationImplementations_count
authenticationImplementationsExists
authenticationImplementations.variables
authenticationImplementations.authenticationType
variables
variables_count
variablesExists
systemTemplate
systemTemplate_count
systemTemplateExists
systemTemplate.company
systemTemplate.marketplaceCompany

Available Filters

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

name
withUpdatable
fromMarketplace
fromApp

Available Fields

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

systems.id
systems.name
systems.label
systems.colour
systems.system_template_id
systems.version
systems.version_name
systems.system_type_id
systems.protocol
systems.date_format
systems.help_link
systems.created_at
systems.updated_at
systems.rate_limit_unit
systems.rate_limit_duration

Available Sorts

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

name

Authorizations

Query parameters

filter[name]stringOptional

Filter results by name.

filter[canonical_key]stringOptional

Filter results by canonical_key.

filter[withUpdatable]stringOptional

Filter results by withUpdatable.

filter[fromMarketplace]stringOptional

Filter results by fromMarketplace.

filter[fromApp]stringOptional

Filter results by fromApp.

filter[id]stringOptional

Filter results by id.

filter[,]stringOptional

Filter results by ,.

includestringOptional

Comma-separated list of relationships to include. Available: logo, systemType, connectors, connectors.authenticationImplementation, endpoints, authenticationImplementations.variables, authenticationImplementations.authenticationType, variables, systemTemplate.company, systemTemplate.marketplaceCompany, endpoints.preScriptVersion, endpoints.postScriptVersion, endpoints.preScriptVersion.script, endpoints.postScriptVersion.script

sortstringOptional

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

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/systems

GET /api/v1/systems HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "name": "My Example",
      "entity_type_id": 1,
      "direction": "Send",
      "http_method": "CONNECT",
      "label": "My Label",
      "colour": "blue",
      "system_template_id": 1,
      "version": 1,
      "version_name": "example_version_name",
      "system_type_id": 1,
      "protocol": "HTTP",
      "date_format": "example_date_format",
      "help_link": "example_help_link",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "rate_limit_unit": "second",
      "rate_limit_duration": "example_rate_limit_duration",
      "endpoint": "example_endpoint",
      "method": "example_method",
      "data_type": "csv",
      "body_format": "none",
      "additional_endpoint_1": "example_additional_endpoint_1",
      "additional_endpoint_2": "example_additional_endpoint_2",
      "timeout": 1,
      "authentication_type_id": 1,
      "returns_multiple_records": "example_returns_multiple_records",
      "pagination_method": "Custom relative URI",
      "schema": "example_schema",
      "endpoint_template_id": 1,
      "data_path": "example_data_path",
      "raw_body": "example_raw_body",
      "deprecated_at": "2025-01-15T10:30:00.000000Z",
      "disable_header_addition": "example_disable_header_addition",
      "response_encoding": "base64",
      "key": "example_key",
      "value": "example_value",
      "secret": "example_secret",
      "logo": "example_logo",
      "pre_script_version_id": 1,
      "post_script_version_id": 1,
      "canonical_key": [],
      "connectors": [],
      "system_type": "Accounting",
      "system_template": [],
      "authentication_implementations": [],
      "authentication_implementations_count": 5,
      "endpoints": [],
      "variables": [],
      "updatable": "example_updatable",
      "modified": "example_modified",
      "is_deployed": true
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/systems",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/systems?page=1",
    "last": "https://api.example.com/api/v1/systems?page=1",
    "prev": null,
    "next": null
  }
}

Store

post

Validation Rules

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

Field

Type

Required

name

string

☑

version_name

string

☑

label

string

☑

colour

string

☑

logo

☑

rate_limit_unit

string

☑

rate_limit_duration

integer

☑

system_type_id

☑

protocol

string

☑

system_template_id

integer

date_format

string

☑

help_link

string

Authorizations

Body

version_namestringRequired

labelstringRequired

colourstring · enumRequiredPossible values:

logostringRequired

rate_limit_unitstring · enumRequiredPossible values:

rate_limit_durationintegerRequired

system_type_idstringRequired

protocolstring · enumRequiredPossible values:

system_template_idintegerOptional

date_formatstringRequired

help_linkstring · nullableOptional

namestringRequired

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/systems

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

{
  "version_name": "example_version_name",
  "label": "My Label",
  "colour": "blue",
  "logo": "example_logo",
  "rate_limit_unit": "second",
  "rate_limit_duration": 1,
  "system_type_id": 1,
  "protocol": "HTTP",
  "system_template_id": 1,
  "date_format": "example_date_format",
  "help_link": "example_help_link",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "name": "My Example",
    "entity_type_id": 1,
    "direction": "Send",
    "http_method": "CONNECT",
    "label": "My Label",
    "colour": "blue",
    "system_template_id": 1,
    "version": 1,
    "version_name": "example_version_name",
    "system_type_id": 1,
    "protocol": "HTTP",
    "date_format": "example_date_format",
    "help_link": "example_help_link",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "rate_limit_unit": "second",
    "rate_limit_duration": "example_rate_limit_duration",
    "endpoint": "example_endpoint",
    "method": "example_method",
    "data_type": "csv",
    "body_format": "none",
    "additional_endpoint_1": "example_additional_endpoint_1",
    "additional_endpoint_2": "example_additional_endpoint_2",
    "timeout": 1,
    "authentication_type_id": 1,
    "returns_multiple_records": "example_returns_multiple_records",
    "pagination_method": "Custom relative URI",
    "schema": "example_schema",
    "endpoint_template_id": 1,
    "data_path": "example_data_path",
    "raw_body": "example_raw_body",
    "deprecated_at": "2025-01-15T10:30:00.000000Z",
    "disable_header_addition": "example_disable_header_addition",
    "response_encoding": "base64",
    "key": "example_key",
    "value": "example_value",
    "secret": "example_secret",
    "logo": "example_logo",
    "pre_script_version_id": 1,
    "post_script_version_id": 1,
    "canonical_key": [],
    "connectors": [],
    "system_type": "Accounting",
    "system_template": [],
    "authentication_implementations": [],
    "authentication_implementations_count": 5,
    "endpoints": [],
    "variables": [],
    "updatable": "example_updatable",
    "modified": "example_modified",
    "is_deployed": true
  }
}

Export

post

Validation Rules

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

Field

Type

Required

system_id

integer

☑

Authorizations

Body

system_idintegerRequired

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/systems/export

POST /api/v1/systems/export HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "system_id": 1
}

{}

Import

post

Validation Rules

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

Field

Type

Required

system

☑

metadata

☑

as_marketplace

Authorizations

Body

systemstringRequired

metadatastringRequired

as_marketplacestringOptional

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/systems/import

POST /api/v1/systems/import HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "system": "example_system",
  "metadata": "example_metadata",
  "as_marketplace": "example_as_marketplace"
}

{}

Postman-Import

post

Validation Rules

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

Field

Type

Required

collection_url

string

collection_file

precog

Authorizations

Body

collection_urlstringOptional

collection_filestringOptional

precogstringOptional

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/systems/import-postman

POST /api/v1/systems/import-postman HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "collection_url": "example_collection_url",
  "collection_file": "example_collection_file",
  "precog": "example_precog"
}

{}

Show

get

Available Includes

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

logo
logo_count
logoExists
systemType
systemType_count
systemTypeExists
connectors
connectors_count
connectorsExists
connectors.authenticationImplementation
endpoints
endpoints_count
endpointsExists
authenticationImplementations
authenticationImplementations_count
authenticationImplementationsExists
authenticationImplementations.variables
authenticationImplementations.authenticationType
variables
variables_count
variablesExists
systemTemplate
systemTemplate_count
systemTemplateExists
systemTemplate.company
systemTemplate.marketplaceCompany

Available Filters

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

name
withUpdatable
fromMarketplace
fromApp

Available Fields

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

systems.id
systems.name
systems.label
systems.colour
systems.system_template_id
systems.version
systems.version_name
systems.system_type_id
systems.protocol
systems.date_format
systems.help_link
systems.created_at
systems.updated_at
systems.rate_limit_unit
systems.rate_limit_duration

Available Sorts

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

name

Authorizations

Path parameters

systemstringRequired

The system identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

filter[canonical_key]stringOptional

Filter results by canonical_key.

filter[withUpdatable]stringOptional

Filter results by withUpdatable.

filter[fromMarketplace]stringOptional

Filter results by fromMarketplace.

filter[fromApp]stringOptional

Filter results by fromApp.

filter[id]stringOptional

Filter results by id.

filter[,]stringOptional

Filter results by ,.

includestringOptional

Comma-separated list of relationships to include. Available: logo, systemType, connectors, connectors.authenticationImplementation, endpoints, authenticationImplementations.variables, authenticationImplementations.authenticationType, variables, systemTemplate.company, systemTemplate.marketplaceCompany, endpoints.preScriptVersion, endpoints.postScriptVersion, endpoints.preScriptVersion.script, endpoints.postScriptVersion.script

sortstringOptional

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

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/systems/{system}

GET /api/v1/systems/{system} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": {
    "id": 1,
    "name": "My Example",
    "entity_type_id": 1,
    "direction": "Send",
    "http_method": "CONNECT",
    "label": "My Label",
    "colour": "blue",
    "system_template_id": 1,
    "version": 1,
    "version_name": "example_version_name",
    "system_type_id": 1,
    "protocol": "HTTP",
    "date_format": "example_date_format",
    "help_link": "example_help_link",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "rate_limit_unit": "second",
    "rate_limit_duration": "example_rate_limit_duration",
    "endpoint": "example_endpoint",
    "method": "example_method",
    "data_type": "csv",
    "body_format": "none",
    "additional_endpoint_1": "example_additional_endpoint_1",
    "additional_endpoint_2": "example_additional_endpoint_2",
    "timeout": 1,
    "authentication_type_id": 1,
    "returns_multiple_records": "example_returns_multiple_records",
    "pagination_method": "Custom relative URI",
    "schema": "example_schema",
    "endpoint_template_id": 1,
    "data_path": "example_data_path",
    "raw_body": "example_raw_body",
    "deprecated_at": "2025-01-15T10:30:00.000000Z",
    "disable_header_addition": "example_disable_header_addition",
    "response_encoding": "base64",
    "key": "example_key",
    "value": "example_value",
    "secret": "example_secret",
    "logo": "example_logo",
    "pre_script_version_id": 1,
    "post_script_version_id": 1,
    "canonical_key": [],
    "connectors": [],
    "system_type": "Accounting",
    "system_template": [],
    "authentication_implementations": [],
    "authentication_implementations_count": 5,
    "endpoints": [],
    "variables": [],
    "updatable": "example_updatable",
    "modified": "example_modified",
    "is_deployed": true
  }
}

Update

put

Validation Rules

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

Field

Type

Required

name

string

version_name

string

label

string

colour

string

rate_limit_unit

string

rate_limit_duration

integer

system_type_id

protocol

string

system_template_id

integer

logo

date_format

string

help_link

string

Authorizations

Path parameters

systemstringRequired

The system identifier.

Body

version_namestringOptional

labelstringOptional

colourstring · enumOptionalPossible values:

rate_limit_unitstring · enumOptionalPossible values:

rate_limit_durationintegerOptional

system_type_idstringOptional

protocolstring · enumOptionalPossible values:

system_template_idintegerOptional

logostringOptional

date_formatstringOptional

help_linkstring · nullableOptional

namestringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/systems/{system}

PUT /api/v1/systems/{system} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 295

{
  "version_name": "example_version_name",
  "label": "My Label",
  "colour": "blue",
  "rate_limit_unit": "second",
  "rate_limit_duration": 1,
  "system_type_id": 1,
  "protocol": "HTTP",
  "system_template_id": 1,
  "logo": "example_logo",
  "date_format": "example_date_format",
  "help_link": "example_help_link",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "name": "My Example",
    "entity_type_id": 1,
    "direction": "Send",
    "http_method": "CONNECT",
    "label": "My Label",
    "colour": "blue",
    "system_template_id": 1,
    "version": 1,
    "version_name": "example_version_name",
    "system_type_id": 1,
    "protocol": "HTTP",
    "date_format": "example_date_format",
    "help_link": "example_help_link",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "rate_limit_unit": "second",
    "rate_limit_duration": "example_rate_limit_duration",
    "endpoint": "example_endpoint",
    "method": "example_method",
    "data_type": "csv",
    "body_format": "none",
    "additional_endpoint_1": "example_additional_endpoint_1",
    "additional_endpoint_2": "example_additional_endpoint_2",
    "timeout": 1,
    "authentication_type_id": 1,
    "returns_multiple_records": "example_returns_multiple_records",
    "pagination_method": "Custom relative URI",
    "schema": "example_schema",
    "endpoint_template_id": 1,
    "data_path": "example_data_path",
    "raw_body": "example_raw_body",
    "deprecated_at": "2025-01-15T10:30:00.000000Z",
    "disable_header_addition": "example_disable_header_addition",
    "response_encoding": "base64",
    "key": "example_key",
    "value": "example_value",
    "secret": "example_secret",
    "logo": "example_logo",
    "pre_script_version_id": 1,
    "post_script_version_id": 1,
    "canonical_key": [],
    "connectors": [],
    "system_type": "Accounting",
    "system_template": [],
    "authentication_implementations": [],
    "authentication_implementations_count": 5,
    "endpoints": [],
    "variables": [],
    "updatable": "example_updatable",
    "modified": "example_modified",
    "is_deployed": true
  }
}

Destroy

delete

Delete a system.

Authorizations

Path parameters

systemstringRequired

The system identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/systems/{system}

DELETE /api/v1/systems/{system} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

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

Index

get

Pagination

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

Available Includes

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

system
system_count
systemExists
system.systemType
authenticationType
authenticationType_count
authenticationTypeExists
variables
variables_count
variablesExists
endpoints
endpoints_count
endpointsExists
preScriptVersion
preScriptVersion_count
preScriptVersionExists
preScriptVersion.script
postScriptVersion
postScriptVersion_count
postScriptVersionExists
postScriptVersion.script

Available Filters

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

name
endpoint
method
additional_endpoint_1
additional_endpoint_2
system_id
authentication_type_id
version

Available Sorts

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

name
endpoint
method
additional_endpoint_1
additional_endpoint_2
system_id
authentication_type_id
version

Authorizations

Path parameters

systemstringRequired

The system identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

filter[endpoint]stringOptional

Filter results by endpoint.

filter[method]stringOptional

Filter results by method.

filter[additional_endpoint_1]stringOptional

Filter results by additional_endpoint_1.

filter[additional_endpoint_2]stringOptional

Filter results by additional_endpoint_2.

filter[system_id]stringOptional

Filter results by system_id.

filter[authentication_type_id]stringOptional

Filter results by authentication_type_id.

filter[version]stringOptional

Filter results by version.

includestringOptional

Comma-separated list of relationships to include. Available: system, system.systemType, authenticationType, variables, endpoints, preScriptVersion.script, postScriptVersion.script

sortstringOptional

Sort field. Prefix with - for descending. Available: name, endpoint, method, additional_endpoint_1, additional_endpoint_2, system_id, authentication_type_id, version

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/systems/{system}/authentication-implementations

GET /api/v1/systems/{system}/authentication-implementations HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "endpoint_ids": "example_endpoint_ids",
      "label": "My Label",
      "key": "example_key",
      "value": "example_value",
      "secret": "example_secret",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "name": "My Example",
      "endpoint": "example_endpoint",
      "method": "example_method",
      "additional_endpoint_1": "example_additional_endpoint_1",
      "additional_endpoint_2": "example_additional_endpoint_2",
      "authentication_type_id": 1,
      "authentication_implementation_template_id": 1,
      "authentication_type": {},
      "system_id": 1,
      "body_format": "none",
      "data_type": "csv",
      "pre_script_version_id": 1,
      "post_script_version_id": 1,
      "timeout": [],
      "system": [],
      "variables": [],
      "endpoints": [],
      "pre_script_version": "example_pre_script_version",
      "post_script_version": "example_post_script_version",
      "modified": "example_modified",
      "help_link": "example_help_link"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/systems/{system}/authentication-implementations",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/systems/{system}/authentication-implementations?page=1",
    "last": "https://api.example.com/api/v1/systems/{system}/authentication-implementations?page=1",
    "prev": null,
    "next": null
  }
}

Store

post

Validation Rules

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

Field

Type

Required

name

string

☑

endpoint

string

☑

method

string

☑

data_type

body_format

additional_endpoint_1

string

additional_endpoint_2

string

timeout

integer

authentication_type_id

☑

help_link

string

Authorizations

Path parameters

systemstringRequired

The system identifier.

Body

endpointstring · nullableRequired

methodstringRequired

data_typestring · enum · nullableOptionalPossible values:

body_formatstring · enum · nullableOptionalPossible values:

additional_endpoint_1string · nullableOptional

additional_endpoint_2string · nullableOptional

timeoutinteger · min: 1 · max: 65535Optional

authentication_type_idstringRequired

help_linkstring · nullableOptional

namestringRequired

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/systems/{system}/authentication-implementations

POST /api/v1/systems/{system}/authentication-implementations HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 299

{
  "endpoint": "example_endpoint",
  "method": "example_method",
  "data_type": "csv",
  "body_format": "none",
  "additional_endpoint_1": "example_additional_endpoint_1",
  "additional_endpoint_2": "example_additional_endpoint_2",
  "timeout": 1,
  "authentication_type_id": 1,
  "help_link": "example_help_link",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "endpoint_ids": "example_endpoint_ids",
    "label": "My Label",
    "key": "example_key",
    "value": "example_value",
    "secret": "example_secret",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "name": "My Example",
    "endpoint": "example_endpoint",
    "method": "example_method",
    "additional_endpoint_1": "example_additional_endpoint_1",
    "additional_endpoint_2": "example_additional_endpoint_2",
    "authentication_type_id": 1,
    "authentication_implementation_template_id": 1,
    "authentication_type": {},
    "system_id": 1,
    "body_format": "none",
    "data_type": "csv",
    "pre_script_version_id": 1,
    "post_script_version_id": 1,
    "timeout": [],
    "system": [],
    "variables": [],
    "endpoints": [],
    "pre_script_version": "example_pre_script_version",
    "post_script_version": "example_post_script_version",
    "modified": "example_modified",
    "help_link": "example_help_link"
  }
}

Show

get

Available Includes

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

system
system_count
systemExists
system.systemType
authenticationType
authenticationType_count
authenticationTypeExists
variables
variables_count
variablesExists
endpoints
endpoints_count
endpointsExists
preScriptVersion
preScriptVersion_count
preScriptVersionExists
preScriptVersion.script
postScriptVersion
postScriptVersion_count
postScriptVersionExists
postScriptVersion.script

Available Filters

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

name
endpoint
method
additional_endpoint_1
additional_endpoint_2
system_id
authentication_type_id
version

Available Sorts

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

name
endpoint
method
additional_endpoint_1
additional_endpoint_2
system_id
authentication_type_id
version

Authorizations

Path parameters

systemstringRequired

The system identifier.

authentication_implementationstringRequired

The authentication implementation identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

filter[endpoint]stringOptional

Filter results by endpoint.

filter[method]stringOptional

Filter results by method.

filter[additional_endpoint_1]stringOptional

Filter results by additional_endpoint_1.

filter[additional_endpoint_2]stringOptional

Filter results by additional_endpoint_2.

filter[system_id]stringOptional

Filter results by system_id.

filter[authentication_type_id]stringOptional

Filter results by authentication_type_id.

filter[version]stringOptional

Filter results by version.

includestringOptional

Comma-separated list of relationships to include. Available: system, system.systemType, authenticationType, variables, endpoints, preScriptVersion.script, postScriptVersion.script

sortstringOptional

Sort field. Prefix with - for descending. Available: name, endpoint, method, additional_endpoint_1, additional_endpoint_2, system_id, authentication_type_id, version

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/systems/{system}/authentication-implementations/{authentication_implementation}

GET /api/v1/systems/{system}/authentication-implementations/{authentication_implementation} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": {
    "id": 1,
    "endpoint_ids": "example_endpoint_ids",
    "label": "My Label",
    "key": "example_key",
    "value": "example_value",
    "secret": "example_secret",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "name": "My Example",
    "endpoint": "example_endpoint",
    "method": "example_method",
    "additional_endpoint_1": "example_additional_endpoint_1",
    "additional_endpoint_2": "example_additional_endpoint_2",
    "authentication_type_id": 1,
    "authentication_implementation_template_id": 1,
    "authentication_type": {},
    "system_id": 1,
    "body_format": "none",
    "data_type": "csv",
    "pre_script_version_id": 1,
    "post_script_version_id": 1,
    "timeout": [],
    "system": [],
    "variables": [],
    "endpoints": [],
    "pre_script_version": "example_pre_script_version",
    "post_script_version": "example_post_script_version",
    "modified": "example_modified",
    "help_link": "example_help_link"
  }
}

Update

put

Validation Rules

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

Field

Type

Required

name

string

endpoint

string

method

string

data_type

body_format

additional_endpoint_1

string

additional_endpoint_2

string

timeout

integer

authentication_type_id

pre_script_version_id

string

post_script_version_id

string

help_link

string

Available Includes

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

system
system_count
systemExists
system.systemType
authenticationType
authenticationType_count
authenticationTypeExists
variables
variables_count
variablesExists
endpoints
endpoints_count
endpointsExists
preScriptVersion
preScriptVersion_count
preScriptVersionExists
preScriptVersion.script
postScriptVersion
postScriptVersion_count
postScriptVersionExists
postScriptVersion.script

Available Filters

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

name
endpoint
method
additional_endpoint_1
additional_endpoint_2
system_id
authentication_type_id
version

Available Sorts

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

name
endpoint
method
additional_endpoint_1
additional_endpoint_2
system_id
authentication_type_id
version

Authorizations

Path parameters

systemstringRequired

The system identifier.

authentication_implementationstringRequired

The authentication implementation identifier.

Body

endpointstring · nullableOptional

methodstringOptional

data_typestring · enum · nullableOptionalPossible values:

body_formatstring · enum · nullableOptionalPossible values:

additional_endpoint_1string · nullableOptional

additional_endpoint_2string · nullableOptional

timeoutinteger · min: 1 · max: 65535Optional

authentication_type_idstringOptional

pre_script_version_idstring · nullableOptional

post_script_version_idstring · nullableOptional

help_linkstring · nullableOptional

namestringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/systems/{system}/authentication-implementations/{authentication_implementation}

PUT /api/v1/systems/{system}/authentication-implementations/{authentication_implementation} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 352

{
  "endpoint": "example_endpoint",
  "method": "example_method",
  "data_type": "csv",
  "body_format": "none",
  "additional_endpoint_1": "example_additional_endpoint_1",
  "additional_endpoint_2": "example_additional_endpoint_2",
  "timeout": 1,
  "authentication_type_id": 1,
  "pre_script_version_id": 1,
  "post_script_version_id": 1,
  "help_link": "example_help_link",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "endpoint_ids": "example_endpoint_ids",
    "label": "My Label",
    "key": "example_key",
    "value": "example_value",
    "secret": "example_secret",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "name": "My Example",
    "endpoint": "example_endpoint",
    "method": "example_method",
    "additional_endpoint_1": "example_additional_endpoint_1",
    "additional_endpoint_2": "example_additional_endpoint_2",
    "authentication_type_id": 1,
    "authentication_implementation_template_id": 1,
    "authentication_type": {},
    "system_id": 1,
    "body_format": "none",
    "data_type": "csv",
    "pre_script_version_id": 1,
    "post_script_version_id": 1,
    "timeout": [],
    "system": [],
    "variables": [],
    "endpoints": [],
    "pre_script_version": "example_pre_script_version",
    "post_script_version": "example_post_script_version",
    "modified": "example_modified",
    "help_link": "example_help_link"
  }
}

Destroy

delete

Delete a authentication implementation.

Authorizations

Path parameters

systemstringRequired

The system identifier.

authentication_implementationstringRequired

The authentication implementation identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/systems/{system}/authentication-implementations/{authentication_implementation}

DELETE /api/v1/systems/{system}/authentication-implementations/{authentication_implementation} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

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

Index

get

Validation Rules

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

Field

Type

Required

interval_start

interval_end

interval_unit

string

model_type

string

key

string

keys

managed_companies

Authorizations

Path parameters

systemstringRequired

The system identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/systems/{system}/endpoint-metrics

GET /api/v1/systems/{system}/endpoint-metrics HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "name": "My Example",
      "entity_type_id": 1,
      "direction": "Send",
      "http_method": "CONNECT",
      "label": "My Label",
      "colour": "blue",
      "system_template_id": 1,
      "version": 1,
      "version_name": "example_version_name",
      "system_type_id": 1,
      "protocol": "HTTP",
      "date_format": "example_date_format",
      "help_link": "example_help_link",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "rate_limit_unit": "second",
      "rate_limit_duration": "example_rate_limit_duration",
      "endpoint": "example_endpoint",
      "method": "example_method",
      "data_type": "csv",
      "body_format": "none",
      "additional_endpoint_1": "example_additional_endpoint_1",
      "additional_endpoint_2": "example_additional_endpoint_2",
      "timeout": 1,
      "authentication_type_id": 1,
      "returns_multiple_records": "example_returns_multiple_records",
      "pagination_method": "Custom relative URI",
      "schema": "example_schema",
      "endpoint_template_id": 1,
      "data_path": "example_data_path",
      "raw_body": "example_raw_body",
      "deprecated_at": "2025-01-15T10:30:00.000000Z",
      "disable_header_addition": "example_disable_header_addition",
      "response_encoding": "base64",
      "key": "example_key",
      "value": "example_value",
      "secret": "example_secret",
      "logo": "example_logo",
      "pre_script_version_id": 1,
      "post_script_version_id": 1,
      "canonical_key": [],
      "connectors": [],
      "system_type": "Accounting",
      "system_template": [],
      "authentication_implementations": [],
      "authentication_implementations_count": 5,
      "endpoints": [],
      "variables": [],
      "updatable": "example_updatable",
      "modified": "example_modified",
      "is_deployed": true
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/systems/{system}/endpoint-metrics",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/systems/{system}/endpoint-metrics?page=1",
    "last": "https://api.example.com/api/v1/systems/{system}/endpoint-metrics?page=1",
    "prev": null,
    "next": null
  }
}

Index

get

Pagination

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

Available Includes

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

connector
connector_count
connectorExists
system
system_count
systemExists
entityType
entityType_count
entityTypeExists
entityType.fieldTags
endpointTemplate
endpointTemplate_count
endpointTemplateExists
variables
variables_count
variablesExists
authenticationImplementations
authenticationImplementations_count
authenticationImplementationsExists
fieldTags
fieldTags_count
fieldTagsExists
filters
filters_count
filtersExists
endpointSchema
endpointSchema_count
endpointSchemaExists
preScriptVersion
preScriptVersion_count
preScriptVersionExists
preScriptVersion.script
postScriptVersion
postScriptVersion_count
postScriptVersionExists
postScriptVersion.script

Available Filters

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

name
system_id
entity_type_id
endpoint
direction
http_method
endpoint_template_id
data_type
deprecated_at
data_path
body_format

Available Fields

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

endpoints.id
endpoints.name
endpoints.entity_type_id
endpoints.direction
endpoints.http_method

Available Sorts

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

name
system_id
entity_type_id
endpoint
direction
http_method
endpoint_template_id
data_type
deprecated_at
data_path
body_format

Authorizations

Path parameters

systemstringRequired

The system identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

filter[system_id]stringOptional

Filter results by system_id.

filter[entity_type_id]stringOptional

Filter results by entity_type_id.

filter[endpoint]stringOptional

Filter results by endpoint.

filter[direction]stringOptional

Filter results by direction.

filter[http_method]stringOptional

Filter results by http_method.

filter[endpoint_template_id]stringOptional

Filter results by endpoint_template_id.

filter[data_type]stringOptional

Filter results by data_type.

filter[deprecated_at]stringOptional

Filter results by deprecated_at.

filter[data_path]stringOptional

Filter results by data_path.

filter[body_format]stringOptional

Filter results by body_format.

includestringOptional

Comma-separated list of relationships to include. Available: connector, system, entityType, entityType.fieldTags, endpointTemplate, variables, authenticationImplementations, fieldTags, filters, endpointSchema, preScriptVersion.script, postScriptVersion.script

sortstringOptional

Sort field. Prefix with - for descending. Available: name, system_id, entity_type_id, endpoint, direction, http_method, endpoint_template_id, data_type, deprecated_at, data_path, body_format

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/systems/{system}/endpoints

GET /api/v1/systems/{system}/endpoints HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "field_path": "example_field_path",
      "tags": "example_tags",
      "label": "My Label",
      "key": "example_key",
      "value": "example_value",
      "secret": "example_secret",
      "variables": "example_variables",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "name": "My Example",
      "system_id": 1,
      "system": {},
      "entity_type_id": 1,
      "entity_type": {},
      "endpoint": "example_endpoint",
      "http_method": "CONNECT",
      "data_type": "csv",
      "pagination_method": "Custom relative URI",
      "deprecated_at": "2025-01-15T10:30:00.000000Z",
      "direction": "Send",
      "returns_multiple_records": true,
      "pre_script_version_id": 1,
      "post_script_version_id": 1,
      "endpoint_schema": [],
      "field_tags": [],
      "data_path": [],
      "body_format": "none",
      "raw_body": [],
      "filters": [],
      "modified": [],
      "help_link": [],
      "authentication_implementations": [],
      "pre_script_version": "example_pre_script_version",
      "post_script_version": "example_post_script_version",
      "disable_header_addition": true,
      "response_encoding": "base64"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/systems/{system}/endpoints",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/systems/{system}/endpoints?page=1",
    "last": "https://api.example.com/api/v1/systems/{system}/endpoints?page=1",
    "prev": null,
    "next": null
  }
}

Store

post

Validation Rules

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

Field

Type

Required

name

string

☑

entity_type_id

integer

endpoint

string

☑

direction

string

☑

returns_multiple_records

☑

http_method

string

☑

data_type

string

☑

pagination_method

string

schema

string

endpoint_template_id

integer

data_path

string

body_format

string

raw_body

string

deprecated_at

help_link

string

disable_header_addition

response_encoding

string

Authorizations

Path parameters

systemstringRequired

The system identifier.

Body

entity_type_idinteger · nullableOptional

endpointstringRequired

directionstring · enumRequiredPossible values:

returns_multiple_recordsstringRequired

http_methodstring · enumRequiredPossible values:

data_typestring · enumRequiredPossible values:

pagination_methodstring · enum · nullableOptionalPossible values:

schemastring · nullableOptional

endpoint_template_idintegerOptional

data_pathstring · nullableOptional

body_formatstring · enumOptionalPossible values:

raw_bodystring · nullableOptional

deprecated_atstring · date-time · nullableOptional

help_linkstring · nullableOptional

disable_header_additionstring · nullableOptional

response_encodingstring · enum · nullableOptionalPossible values:

namestringRequiredPattern: ^[a-zA-Z0-9 \-&\+_]+$

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/systems/{system}/endpoints

POST /api/v1/systems/{system}/endpoints HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 536

{
  "entity_type_id": 1,
  "endpoint": "example_endpoint",
  "direction": "Send",
  "returns_multiple_records": "example_returns_multiple_records",
  "http_method": "CONNECT",
  "data_type": "csv",
  "pagination_method": "Custom relative URI",
  "schema": "example_schema",
  "endpoint_template_id": 1,
  "data_path": "example_data_path",
  "body_format": "none",
  "raw_body": "example_raw_body",
  "deprecated_at": "2025-01-15T10:30:00.000000Z",
  "help_link": "example_help_link",
  "disable_header_addition": "example_disable_header_addition",
  "response_encoding": "base64",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "field_path": "example_field_path",
    "tags": "example_tags",
    "label": "My Label",
    "key": "example_key",
    "value": "example_value",
    "secret": "example_secret",
    "variables": "example_variables",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "name": "My Example",
    "system_id": 1,
    "system": {},
    "entity_type_id": 1,
    "entity_type": {},
    "endpoint": "example_endpoint",
    "http_method": "CONNECT",
    "data_type": "csv",
    "pagination_method": "Custom relative URI",
    "deprecated_at": "2025-01-15T10:30:00.000000Z",
    "direction": "Send",
    "returns_multiple_records": true,
    "pre_script_version_id": 1,
    "post_script_version_id": 1,
    "endpoint_schema": [],
    "field_tags": [],
    "data_path": [],
    "body_format": "none",
    "raw_body": [],
    "filters": [],
    "modified": [],
    "help_link": [],
    "authentication_implementations": [],
    "pre_script_version": "example_pre_script_version",
    "post_script_version": "example_post_script_version",
    "disable_header_addition": true,
    "response_encoding": "base64"
  }
}

Wsdl-Ingest

post

Validation Rules

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

Field

Type

Required

wsdl_url

string

update_existing

☑

wsdl_file

Authorizations

Path parameters

systemstringRequired

The system identifier.

Body

wsdl_urlstringOptional

update_existingstringRequired

wsdl_filestringOptional

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/systems/{system}/endpoints/ingest-wsdl

POST /api/v1/systems/{system}/endpoints/ingest-wsdl HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "wsdl_url": "example_wsdl_url",
  "update_existing": "example_update_existing",
  "wsdl_file": "example_wsdl_file"
}

{}

Show

get

Available Includes

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

connector
connector_count
connectorExists
system
system_count
systemExists
entityType
entityType_count
entityTypeExists
entityType.fieldTags
endpointTemplate
endpointTemplate_count
endpointTemplateExists
variables
variables_count
variablesExists
authenticationImplementations
authenticationImplementations_count
authenticationImplementationsExists
fieldTags
fieldTags_count
fieldTagsExists
filters
filters_count
filtersExists
endpointSchema
endpointSchema_count
endpointSchemaExists
preScriptVersion
preScriptVersion_count
preScriptVersionExists
preScriptVersion.script
postScriptVersion
postScriptVersion_count
postScriptVersionExists
postScriptVersion.script

Available Filters

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

name
system_id
entity_type_id
endpoint
direction
http_method
endpoint_template_id
data_type
deprecated_at
data_path
body_format

Available Fields

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

endpoints.id
endpoints.name
endpoints.entity_type_id
endpoints.direction
endpoints.http_method

Available Sorts

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

name
system_id
entity_type_id
endpoint
direction
http_method
endpoint_template_id
data_type
deprecated_at
data_path
body_format

Authorizations

Path parameters

systemstringRequired

The system identifier.

endpointstringRequired

The endpoint identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

filter[system_id]stringOptional

Filter results by system_id.

filter[entity_type_id]stringOptional

Filter results by entity_type_id.

filter[endpoint]stringOptional

Filter results by endpoint.

filter[direction]stringOptional

Filter results by direction.

filter[http_method]stringOptional

Filter results by http_method.

filter[endpoint_template_id]stringOptional

Filter results by endpoint_template_id.

filter[data_type]stringOptional

Filter results by data_type.

filter[deprecated_at]stringOptional

Filter results by deprecated_at.

filter[data_path]stringOptional

Filter results by data_path.

filter[body_format]stringOptional

Filter results by body_format.

includestringOptional

Comma-separated list of relationships to include. Available: connector, system, entityType, entityType.fieldTags, endpointTemplate, variables, authenticationImplementations, fieldTags, filters, endpointSchema, preScriptVersion.script, postScriptVersion.script

sortstringOptional

Sort field. Prefix with - for descending. Available: name, system_id, entity_type_id, endpoint, direction, http_method, endpoint_template_id, data_type, deprecated_at, data_path, body_format

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/systems/{system}/endpoints/{endpoint}

GET /api/v1/systems/{system}/endpoints/{endpoint} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": {
    "id": 1,
    "field_path": "example_field_path",
    "tags": "example_tags",
    "label": "My Label",
    "key": "example_key",
    "value": "example_value",
    "secret": "example_secret",
    "variables": "example_variables",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "name": "My Example",
    "system_id": 1,
    "system": {},
    "entity_type_id": 1,
    "entity_type": {},
    "endpoint": "example_endpoint",
    "http_method": "CONNECT",
    "data_type": "csv",
    "pagination_method": "Custom relative URI",
    "deprecated_at": "2025-01-15T10:30:00.000000Z",
    "direction": "Send",
    "returns_multiple_records": true,
    "pre_script_version_id": 1,
    "post_script_version_id": 1,
    "endpoint_schema": [],
    "field_tags": [],
    "data_path": [],
    "body_format": "none",
    "raw_body": [],
    "filters": [],
    "modified": [],
    "help_link": [],
    "authentication_implementations": [],
    "pre_script_version": "example_pre_script_version",
    "post_script_version": "example_post_script_version",
    "disable_header_addition": true,
    "response_encoding": "base64"
  }
}

Update

put

Validation Rules

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

Field

Type

Required

name

string

entity_type_id

integer

endpoint

string

direction

string

returns_multiple_records

http_method

string

data_type

string

pagination_method

string

schema

string

endpoint_template_id

integer

data_path

string

body_format

string

raw_body

string

deprecated_at

help_link

string

pre_script_version_id

string

post_script_version_id

string

disable_header_addition

response_encoding

string

Authorizations

Path parameters

systemstringRequired

The system identifier.

endpointstringRequired

The endpoint identifier.

Body

entity_type_idinteger · nullableOptional

endpointstringOptional

directionstring · enumOptionalPossible values:

returns_multiple_recordsstringOptional

http_methodstring · enumOptionalPossible values:

data_typestring · enumOptionalPossible values:

pagination_methodstring · enum · nullableOptionalPossible values:

schemastring · nullableOptional

endpoint_template_idintegerOptional

data_pathstring · nullableOptional

body_formatstring · enumOptionalPossible values:

raw_bodystring · nullableOptional

deprecated_atstring · nullableOptional

help_linkstring · nullableOptional

pre_script_version_idstring · nullableOptional

post_script_version_idstring · nullableOptional

disable_header_additionstringOptional

response_encodingstring · enum · nullableOptionalPossible values:

namestringOptionalPattern: ^[a-zA-Z0-9 \-&\+_]+$

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/systems/{system}/endpoints/{endpoint}

PUT /api/v1/systems/{system}/endpoints/{endpoint} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 589

{
  "entity_type_id": 1,
  "endpoint": "example_endpoint",
  "direction": "Send",
  "returns_multiple_records": "example_returns_multiple_records",
  "http_method": "CONNECT",
  "data_type": "csv",
  "pagination_method": "Custom relative URI",
  "schema": "example_schema",
  "endpoint_template_id": 1,
  "data_path": "example_data_path",
  "body_format": "none",
  "raw_body": "example_raw_body",
  "deprecated_at": "2025-01-15T10:30:00.000000Z",
  "help_link": "example_help_link",
  "pre_script_version_id": 1,
  "post_script_version_id": 1,
  "disable_header_addition": "example_disable_header_addition",
  "response_encoding": "base64",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "field_path": "example_field_path",
    "tags": "example_tags",
    "label": "My Label",
    "key": "example_key",
    "value": "example_value",
    "secret": "example_secret",
    "variables": "example_variables",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "name": "My Example",
    "system_id": 1,
    "system": {},
    "entity_type_id": 1,
    "entity_type": {},
    "endpoint": "example_endpoint",
    "http_method": "CONNECT",
    "data_type": "csv",
    "pagination_method": "Custom relative URI",
    "deprecated_at": "2025-01-15T10:30:00.000000Z",
    "direction": "Send",
    "returns_multiple_records": true,
    "pre_script_version_id": 1,
    "post_script_version_id": 1,
    "endpoint_schema": [],
    "field_tags": [],
    "data_path": [],
    "body_format": "none",
    "raw_body": [],
    "filters": [],
    "modified": [],
    "help_link": [],
    "authentication_implementations": [],
    "pre_script_version": "example_pre_script_version",
    "post_script_version": "example_post_script_version",
    "disable_header_addition": true,
    "response_encoding": "base64"
  }
}

Destroy

delete

Delete a endpoint.

Authorizations

Path parameters

systemstringRequired

The system identifier.

endpointstringRequired

The endpoint identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/systems/{system}/endpoints/{endpoint}

DELETE /api/v1/systems/{system}/endpoints/{endpoint} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

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

Clone

post

Clone for clone.

Authorizations

Path parameters

systemstringRequired

The system identifier.

endpointstringRequired

The endpoint identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/systems/{system}/endpoints/{endpoint}/clone

POST /api/v1/systems/{system}/endpoints/{endpoint}/clone HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{}

Upload

post

Validation Rules

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

Field

Type

Required

private

Authorizations

Path parameters

systemstringRequired

The system identifier.

Body

privatestringOptional

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/systems/{system}/upload

POST /api/v1/systems/{system}/upload HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "private": "example_private"
}

{}

Index

get

Pagination

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

Available Filters

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

label
key
value

Available Sorts

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

label
key
value

Authorizations

Path parameters

systemstringRequired

The system identifier.

Query parameters

filter[label]stringOptional

Filter results by label.

filter[key]stringOptional

Filter results by key.

filter[value]stringOptional

Filter results by value.

sortstringOptional

Sort field. Prefix with - for descending. Available: label, key, value

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/systems/{system}/variables

GET /api/v1/systems/{system}/variables HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "label": "My Label",
      "key": "example_key",
      "value": "example_value",
      "secret": "example_secret",
      "locked": "example_locked",
      "configurable": "example_configurable",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "modified": "example_modified",
      "pivot": "example_pivot",
      "required": true,
      "advanced": true,
      "alias": "example_alias"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/systems/{system}/variables",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/systems/{system}/variables?page=1",
    "last": "https://api.example.com/api/v1/systems/{system}/variables?page=1",
    "prev": null,
    "next": null
  }
}

Store

post

Validation Rules

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

Field

Type

Required

label

string

☑

key

string

☑

value

string

secret

pivot.alias

string

pivot.configurable

pivot.required

pivot.advanced

Authorizations

Path parameters

systemstringRequired

The system identifier.

Body

labelstringRequired

keystringRequired

valuestringOptional

secretstringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/systems/{system}/variables

POST /api/v1/systems/{system}/variables HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 222

{
  "label": "My Label",
  "key": "example_key",
  "value": "example_value",
  "secret": "example_secret",
  "pivot": {
    "alias": "example_alias",
    "configurable": "example_configurable",
    "required": "example_required",
    "advanced": "example_advanced"
  }
}

{
  "data": {
    "id": 1,
    "label": "My Label",
    "key": "example_key",
    "value": "example_value",
    "secret": "example_secret",
    "locked": "example_locked",
    "configurable": "example_configurable",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "modified": "example_modified",
    "pivot": "example_pivot",
    "required": true,
    "advanced": true,
    "alias": "example_alias"
  }
}

Destroy

delete

Delete a variable.

Authorizations

Path parameters

systemstringRequired

The system identifier.

variablestringRequired

The variable identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/systems/{system}/variables/{variable}

DELETE /api/v1/systems/{system}/variables/{variable} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

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

hashtagIndex

hashtagPagination

hashtagAvailable Includes

hashtagAvailable Filters

hashtagAvailable Fields

hashtagAvailable Sorts

hashtagStore

hashtagValidation Rules

hashtagExport

hashtagValidation Rules

hashtagImport

hashtagValidation Rules

hashtagPostman-Import

hashtagValidation Rules

hashtagShow

hashtagAvailable Includes

hashtagAvailable Filters

hashtagAvailable Fields

hashtagAvailable Sorts

hashtagUpdate

hashtagValidation Rules

hashtagDestroy

hashtagIndex

hashtagPagination

hashtagAvailable Includes

hashtagAvailable Filters

hashtagAvailable Sorts

hashtagStore

hashtagValidation Rules

hashtagShow

hashtagAvailable Includes

hashtagAvailable Filters

hashtagAvailable Sorts

hashtagUpdate

hashtagValidation Rules

hashtagAvailable Includes

hashtagAvailable Filters

hashtagAvailable Sorts

hashtagDestroy

hashtagIndex

hashtagValidation Rules

hashtagIndex

hashtagPagination

hashtagAvailable Includes

hashtagAvailable Filters

hashtagAvailable Fields

hashtagAvailable Sorts

hashtagStore

hashtagValidation Rules

hashtagWsdl-Ingest

hashtagValidation Rules

hashtagShow

hashtagAvailable Includes

hashtagAvailable Filters

hashtagAvailable Fields

hashtagAvailable Sorts

hashtagUpdate

hashtagValidation Rules

hashtagDestroy

hashtagClone

hashtagUpload

hashtagValidation Rules

hashtagIndex

hashtagPagination

hashtagAvailable Filters

hashtagAvailable Sorts

hashtagStore

hashtagValidation Rules

hashtagDestroy

Index

Pagination

Available Includes

Available Filters

Available Fields

Available Sorts

Store

Validation Rules

Export

Validation Rules

Import

Validation Rules

Postman-Import

Validation Rules

Show

Available Includes

Available Filters

Available Fields

Available Sorts

Update

Validation Rules

Destroy

Index

Pagination

Available Includes

Available Filters

Available Sorts

Store

Validation Rules

Show

Available Includes

Available Filters

Available Sorts

Update

Validation Rules

Available Includes

Available Filters

Available Sorts

Destroy

Index

Validation Rules

Index

Pagination

Available Includes

Available Filters

Available Fields

Available Sorts

Store

Validation Rules

Wsdl-Ingest

Validation Rules

Show

Available Includes

Available Filters

Available Fields

Available Sorts

Update

Validation Rules

Destroy

Clone

Upload

Validation Rules

Index

Pagination

Available Filters

Available Sorts

Store

Validation Rules

Destroy