System Templates

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.

• systemType

• systemType_count

• systemTypeExists

• company

• company_count

• companyExists

• publicCompany

• publicCompany_count

• publicCompanyExists

• marketplaceCompany

• marketplaceCompany_count

• marketplaceCompanyExists

• logo

• logo_count

• logoExists

• authenticationImplementationTemplates

• authenticationImplementationTemplates_count

• authenticationImplementationTemplatesExists

• authenticationImplementationTemplates.variableTemplates

• authenticationImplementationTemplates.authenticationType

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

• hidden_from_marketplace

• visible_for_marketplace

• system_type_id

• id

• private

• platformApp

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

• created_at

Authorizations

ApiKeyAuth

Query parameters

filter[name]stringOptional

Filter results by name.

filter[hidden_from_marketplace]stringOptional

Filter results by hidden_from_marketplace.

filter[visible_for_marketplace]stringOptional

Filter results by visible_for_marketplace.

filter[system_type_id]stringOptional

Filter results by system_type_id.

filter[id]stringOptional

Filter results by id.

filter[private]stringOptional

Filter results by private.

filter[visibility]stringOptional

Filter results by visibility.

filter[platformApp]stringOptional

Filter results by platformApp.

filter[forPlatformApp]stringOptional

Filter results by forPlatformApp.

includestringOptional

Comma-separated list of relationships to include. Available: systemType, company, publicCompany, marketplaceCompany, logo, authenticationImplementationTemplates.variableTemplates, authenticationImplementationTemplates.authenticationType

sortstringOptional

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

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/patchworks/system-templates

HTTPcURLJavaScriptPython

GET /api/v1/patchworks/system-templates HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/patchworks/system-templates",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/patchworks/system-templates?page=1",
    "last": "https://api.example.com/api/v1/patchworks/system-templates?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	☑
label	string	☑
colour	string	☑
logo_url	string	☑
version	integer	☑
version_name	string	☑
rate_limit_unit	string	☑
rate_limit_duration	integer	☑
system_type_id		☑
protocol	string	☑
company_id		☑
date_format	string	☑
help_link	string

Authorizations

ApiKeyAuth

Body

application/json

labelstringRequired

colourstring · enumRequiredPossible values:

logo_urlstring · uriRequired

versionintegerRequired

version_namestringRequired

rate_limit_unitstring · enumRequiredPossible values:

rate_limit_durationintegerRequired

system_type_idstringRequired

protocolstring · enumRequiredPossible values:

company_idstringRequired

date_formatstringRequired

help_linkstring · nullableOptional

namestringRequired

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/patchworks/system-templates

HTTPcURLJavaScriptPython

POST /api/v1/patchworks/system-templates HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 310

{
  "label": "My Label",
  "colour": "blue",
  "logo_url": "https://example.com",
  "version": 1,
  "version_name": "example_version_name",
  "rate_limit_unit": "second",
  "rate_limit_duration": 1,
  "system_type_id": 1,
  "protocol": "HTTP",
  "company_id": 1,
  "date_format": "example_date_format",
  "help_link": "example_help_link",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Update

put

Validation Rules

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

Field	Type	Required
name	string
label	string
colour	string
logo_url	string
version	integer
version_name	string
rate_limit_unit	string
rate_limit_duration	integer
system_type_id
protocol	string
company_id
date_format	string
help_link	string

Authorizations

ApiKeyAuth

Path parameters

system_templatestringRequired

The system template identifier.

Body

application/json

labelstringOptional

colourstring · enumOptionalPossible values:

logo_urlstring · uriOptional

versionintegerOptional

version_namestringOptional

rate_limit_unitstring · enumOptionalPossible values:

rate_limit_durationintegerOptional

system_type_idstringOptional

protocolstring · enumOptionalPossible values:

company_idstringOptional

date_formatstringOptional

help_linkstring · nullableOptional

namestringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/patchworks/system-templates/{system_template}

HTTPcURLJavaScriptPython

PUT /api/v1/patchworks/system-templates/{system_template} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 310

{
  "label": "My Label",
  "colour": "blue",
  "logo_url": "https://example.com",
  "version": 1,
  "version_name": "example_version_name",
  "rate_limit_unit": "second",
  "rate_limit_duration": 1,
  "system_type_id": 1,
  "protocol": "HTTP",
  "company_id": 1,
  "date_format": "example_date_format",
  "help_link": "example_help_link",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Destroy

delete

Delete a system template.

Authorizations

ApiKeyAuth

Path parameters

system_templatestringRequired

The system template identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/patchworks/system-templates/{system_template}

HTTPcURLJavaScriptPython

DELETE /api/v1/patchworks/system-templates/{system_template} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

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

Install

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
overwrite
system_id	integer
platform_app_key	string

Authorizations

ApiKeyAuth

Path parameters

systemTemplatestringRequired

The systemTemplate identifier.

Body

application/json

overwritestringOptional

system_idintegerOptional

platform_app_keystringOptional

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/system-templates/{systemTemplate}

HTTPcURLJavaScriptPython

POST /api/v1/system-templates/{systemTemplate} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "overwrite": "example_overwrite",
  "system_id": 1,
  "platform_app_key": "example_platform_app_key"
}

{}