# Systems ## List Systems > Lists all systems. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`.\ > \ > \## 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 ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"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}}}}},"paths":{"/api/v1/systems":{"get":{"summary":"List Systems","description":"Lists all systems. Note: In the Patchworks dashboard, a `system` is known as a `connector`.\n\n## Pagination\n\nPagination is available for this request. Please see the section on using pagination for more details.\n\n## Available Includes\n\nThese 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.\n\n- logo\n- logo_count\n- logoExists\n- systemType\n- systemType_count\n- systemTypeExists\n- connectors\n- connectors_count\n- connectorsExists\n- connectors.authenticationImplementation\n- endpoints\n- endpoints_count\n- endpointsExists\n- authenticationImplementations\n- authenticationImplementations_count\n- authenticationImplementationsExists\n- authenticationImplementations.variables\n- authenticationImplementations.authenticationType\n- variables\n- variables_count\n- variablesExists\n- systemTemplate\n- systemTemplate_count\n- systemTemplateExists\n- systemTemplate.company\n- systemTemplate.marketplaceCompany\n\n\n## Available Filters\n\nThese are the filters that can be used to specific the data to return. Please see the section on using filters for more details.\n\n- name\n- withUpdatable\n- fromMarketplace\n- fromApp\n\n\n## Available Fields\n\nThese are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.\n\n- systems.id\n- systems.name\n- systems.label\n- systems.colour\n- systems.system_template_id\n- systems.version\n- systems.version_name\n- systems.system_type_id\n- systems.protocol\n- systems.date_format\n- systems.help_link\n- systems.created_at\n- systems.updated_at\n- systems.rate_limit_unit\n- systems.rate_limit_duration\n\n\n## Available Sorts\n\nThese are the sorts that can be used order the returned data. Please see the section on using sorting for more details.\n\n- name","parameters":[{"name":"filter[name]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by name."},{"name":"filter[canonical_key]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by canonical_key."},{"name":"filter[withUpdatable]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by withUpdatable."},{"name":"filter[fromMarketplace]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by fromMarketplace."},{"name":"filter[fromApp]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by fromApp."},{"name":"filter[id]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by id."},{"name":"filter[,]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by ,."},{"name":"include","in":"query","required":false,"schema":{"type":"string"},"description":"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"},{"name":"sort","in":"query","required":false,"schema":{"type":"string"},"description":"Sort field. Prefix with - for descending. Available: name"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1},"description":"Page number for pagination."},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Number of results per page."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemsListResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Systems"]}}}} ``` ## Create System > Creates a new system. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`.\ > \ > \## 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 | | ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"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"}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"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"]}}},"paths":{"/api/v1/systems":{"post":{"summary":"Create System","description":"Creates a new system. Note: In the Patchworks dashboard, a `system` is known as a `connector`.\n\n## Validation Rules\n\nThese 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\n\n| Field | Type | Required |\n|---|---|---|\n| name | string | ☑ |\n| version_name | string | ☑ |\n| label | string | ☑ |\n| colour | string | ☑ |\n| logo | | ☑ |\n| rate_limit_unit | string | ☑ |\n| rate_limit_duration | integer | ☑ |\n| system_type_id | | ☑ |\n| protocol | string | ☑ |\n| system_template_id | integer | |\n| date_format | string | ☑ |\n| help_link | string | |","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemsResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemsStoreRequest"}}}},"tags":["Systems"],"parameters":[]}}}} ``` ## Get System > Retrieves details for a given system. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`.\ > \## 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 ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"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"}}}}},"paths":{"/api/v1/systems/{system}":{"get":{"summary":"Get System","description":"Retrieves details for a given system. Note: In the Patchworks dashboard, a `system` is known as a `connector`.\n## Available Includes\n\nThese 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.\n\n- logo\n- logo_count\n- logoExists\n- systemType\n- systemType_count\n- systemTypeExists\n- connectors\n- connectors_count\n- connectorsExists\n- connectors.authenticationImplementation\n- endpoints\n- endpoints_count\n- endpointsExists\n- authenticationImplementations\n- authenticationImplementations_count\n- authenticationImplementationsExists\n- authenticationImplementations.variables\n- authenticationImplementations.authenticationType\n- variables\n- variables_count\n- variablesExists\n- systemTemplate\n- systemTemplate_count\n- systemTemplateExists\n- systemTemplate.company\n- systemTemplate.marketplaceCompany\n\n\n## Available Filters\n\nThese are the filters that can be used to specific the data to return. Please see the section on using filters for more details.\n\n- name\n- withUpdatable\n- fromMarketplace\n- fromApp\n\n\n## Available Fields\n\nThese are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.\n\n- systems.id\n- systems.name\n- systems.label\n- systems.colour\n- systems.system_template_id\n- systems.version\n- systems.version_name\n- systems.system_type_id\n- systems.protocol\n- systems.date_format\n- systems.help_link\n- systems.created_at\n- systems.updated_at\n- systems.rate_limit_unit\n- systems.rate_limit_duration\n\n\n## Available Sorts\n\nThese are the sorts that can be used order the returned data. Please see the section on using sorting for more details.\n\n- name","parameters":[{"name":"system","in":"path","required":true,"schema":{"type":"string"},"description":"The system identifier."},{"name":"filter[name]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by name."},{"name":"filter[canonical_key]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by canonical_key."},{"name":"filter[withUpdatable]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by withUpdatable."},{"name":"filter[fromMarketplace]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by fromMarketplace."},{"name":"filter[fromApp]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by fromApp."},{"name":"filter[id]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by id."},{"name":"filter[,]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by ,."},{"name":"include","in":"query","required":false,"schema":{"type":"string"},"description":"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"},{"name":"sort","in":"query","required":false,"schema":{"type":"string"},"description":"Sort field. Prefix with - for descending. Available: name"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1},"description":"Page number for pagination."},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Number of results per page."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemsResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Systems"]}}}} ``` ## Update System > Updates an existing system. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`.\ > \ > \## 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 | | ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"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"}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"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"}}}}},"paths":{"/api/v1/systems/{system}":{"put":{"summary":"Update System","description":"Updates an existing system. Note: In the Patchworks dashboard, a `system` is known as a `connector`.\n\n## Validation Rules\n\nThese 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\n\n| Field | Type | Required |\n|---|---|---|\n| name | string | |\n| version_name | string | |\n| label | string | |\n| colour | string | |\n| rate_limit_unit | string | |\n| rate_limit_duration | integer | |\n| system_type_id | | |\n| protocol | string | |\n| system_template_id | integer | |\n| logo | | |\n| date_format | string | |\n| help_link | string | |","parameters":[{"name":"system","in":"path","required":true,"schema":{"type":"string"},"description":"The system identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemsResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemsUpdateRequest"}}}},"tags":["Systems"]}}}} ``` ## Delete System > Deletes a given system. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`. ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"MessageResponse":{"type":"object","properties":{"message":{"type":"string"}}}}},"paths":{"/api/v1/systems/{system}":{"delete":{"summary":"Delete System","description":"Deletes a given system. Note: In the Patchworks dashboard, a `system` is known as a `connector`.","parameters":[{"name":"system","in":"path","required":true,"schema":{"type":"string"},"description":"The system identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Systems"]}}}} ``` ## Export System > Exports a given system. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`.\ > \ > \## 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 | \☑ | ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"SystemsExportExportRequest":{"type":"object","properties":{"system_id":{"type":"integer"}},"required":["system_id"]}}},"paths":{"/api/v1/systems/export":{"post":{"summary":"Export System","description":"Exports a given system. Note: In the Patchworks dashboard, a `system` is known as a `connector`.\n\n## Validation Rules\n\nThese 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\n\n| Field | Type | Required |\n|---|---|---|\n| system_id | integer | ☑ |","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemsExportExportRequest"}}}},"tags":["Systems"],"parameters":[]}}}} ``` ## Import System > To be confirmed. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`. Import for import.\ > \ > \## 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 | | | ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"SystemsImportImportRequest":{"type":"object","properties":{"system":{"type":"string"},"metadata":{"type":"string"},"as_marketplace":{"type":"string"}},"required":["system","metadata"]}}},"paths":{"/api/v1/systems/import":{"post":{"summary":"Import System","description":"To be confirmed. Note: In the Patchworks dashboard, a `system` is known as a `connector`. Import for import.\n\n## Validation Rules\n\nThese 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\n\n| Field | Type | Required |\n|---|---|---|\n| system | | ☑ |\n| metadata | | ☑ |\n| as_marketplace | | |","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemsImportImportRequest"}}}},"tags":["Systems"],"parameters":[]}}}} ``` ## Postman Import > Creates a system from a Postman import. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`.\ > \ > \## 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 | | | ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"SystemsPostmanImportImportPostmanRequest":{"type":"object","properties":{"collection_url":{"type":"string"},"collection_file":{"type":"string"},"precog":{"type":"string"}}}}},"paths":{"/api/v1/systems/import-postman":{"post":{"summary":"Postman Import","description":"Creates a system from a Postman import. Note: In the Patchworks dashboard, a `system` is known as a `connector`.\n\n## Validation Rules\n\nThese 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\n\n| Field | Type | Required |\n|---|---|---|\n| collection_url | string | |\n| collection_file | | |\n| precog | | |","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemsPostmanImportImportPostmanRequest"}}}},"tags":["Systems"],"parameters":[]}}}} ``` ## Upload System > Uploads a system to your private marketplace. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`.\ > \ > \## 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 | | | ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"SystemsUploadUploadRequest":{"type":"object","properties":{"private":{"type":"string"}}}}},"paths":{"/api/v1/systems/{system}/upload":{"post":{"summary":"Upload System","description":"Uploads a system to your private marketplace. Note: In the Patchworks dashboard, a `system` is known as a `connector`.\n\n## Validation Rules\n\nThese 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\n\n| Field | Type | Required |\n|---|---|---|\n| private | | |","parameters":[{"name":"system","in":"path","required":true,"schema":{"type":"string"},"description":"The system identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemsUploadUploadRequest"}}}},"tags":["Systems"]}}}} ``` ## List System Endpoints > Retrieves a paginated list of endpoints for a given system. Can be filtered by \`name\`, \`direction\`, \`http\_method\`, and other criteria. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`.\ > \ > \## 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 ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"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}}}}},"paths":{"/api/v1/systems/{system}/endpoints":{"get":{"summary":"List System Endpoints","description":"Retrieves a paginated list of endpoints for a given system. Can be filtered by `name`, `direction`, `http_method`, and other criteria. Note: In the Patchworks dashboard, a `system` is known as a `connector`.\n\n## Pagination\n\nPagination is available for this request. Please see the section on using pagination for more details.\n\n## Available Includes\n\nThese 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.\n\n- connector\n- connector_count\n- connectorExists\n- system\n- system_count\n- systemExists\n- entityType\n- entityType_count\n- entityTypeExists\n- entityType.fieldTags\n- endpointTemplate\n- endpointTemplate_count\n- endpointTemplateExists\n- variables\n- variables_count\n- variablesExists\n- authenticationImplementations\n- authenticationImplementations_count\n- authenticationImplementationsExists\n- fieldTags\n- fieldTags_count\n- fieldTagsExists\n- filters\n- filters_count\n- filtersExists\n- endpointSchema\n- endpointSchema_count\n- endpointSchemaExists\n- preScriptVersion\n- preScriptVersion_count\n- preScriptVersionExists\n- preScriptVersion.script\n- postScriptVersion\n- postScriptVersion_count\n- postScriptVersionExists\n- postScriptVersion.script\n\n\n## Available Filters\n\nThese are the filters that can be used to specific the data to return. Please see the section on using filters for more details.\n\n- name\n- system_id\n- entity_type_id\n- endpoint\n- direction\n- http_method\n- endpoint_template_id\n- data_type\n- deprecated_at\n- data_path\n- body_format\n\n\n## Available Fields\n\nThese are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.\n\n- endpoints.id\n- endpoints.name\n- endpoints.entity_type_id\n- endpoints.direction\n- endpoints.http_method\n\n\n## Available Sorts\n\nThese are the sorts that can be used order the returned data. Please see the section on using sorting for more details.\n\n- name\n- system_id\n- entity_type_id\n- endpoint\n- direction\n- http_method\n- endpoint_template_id\n- data_type\n- deprecated_at\n- data_path\n- body_format","parameters":[{"name":"system","in":"path","required":true,"schema":{"type":"string"},"description":"The system identifier."},{"name":"filter[name]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by name."},{"name":"filter[system_id]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by system_id."},{"name":"filter[entity_type_id]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by entity_type_id."},{"name":"filter[endpoint]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by endpoint."},{"name":"filter[direction]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by direction."},{"name":"filter[http_method]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by http_method."},{"name":"filter[endpoint_template_id]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by endpoint_template_id."},{"name":"filter[data_type]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by data_type."},{"name":"filter[deprecated_at]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by deprecated_at."},{"name":"filter[data_path]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by data_path."},{"name":"filter[body_format]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by body_format."},{"name":"include","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of relationships to include. Available: connector, system, entityType, entityType.fieldTags, endpointTemplate, variables, authenticationImplementations, fieldTags, filters, endpointSchema, preScriptVersion.script, postScriptVersion.script"},{"name":"sort","in":"query","required":false,"schema":{"type":"string"},"description":"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"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1},"description":"Page number for pagination."},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Number of results per page."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndpointsListResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Systems"]}}}} ``` ## Create System Endpoint > Creates a new endpoint for a given system. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`.\ > \ > \## 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 | | ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"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"]}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"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"]}}},"paths":{"/api/v1/systems/{system}/endpoints":{"post":{"summary":"Create System Endpoint","description":"Creates a new endpoint for a given system. Note: In the Patchworks dashboard, a `system` is known as a `connector`.\n\n## Validation Rules\n\nThese 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\n\n| Field | Type | Required |\n|---|---|---|\n| name | string | ☑ |\n| entity_type_id | integer | |\n| endpoint | string | ☑ |\n| direction | string | ☑ |\n| returns_multiple_records | | ☑ |\n| http_method | string | ☑ |\n| data_type | string | ☑ |\n| pagination_method | string | |\n| schema | string | |\n| endpoint_template_id | integer | |\n| data_path | string | |\n| body_format | string | |\n| raw_body | string | |\n| deprecated_at | | |\n| help_link | string | |\n| disable_header_addition | | |\n| response_encoding | string | |","parameters":[{"name":"system","in":"path","required":true,"schema":{"type":"string"},"description":"The system identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndpointsResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemsStoreEndpointsRequest"}}}},"tags":["Systems"]}}}} ``` ## Wsdl Ingest > To be confirmed. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`.\ > \ > \## 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 | | | ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"SystemsWsdlIngestIngestWsdlRequest":{"type":"object","properties":{"wsdl_url":{"type":"string"},"update_existing":{"type":"string"},"wsdl_file":{"type":"string"}},"required":["update_existing"]}}},"paths":{"/api/v1/systems/{system}/endpoints/ingest-wsdl":{"post":{"summary":"Wsdl Ingest","description":"To be confirmed. Note: In the Patchworks dashboard, a `system` is known as a `connector`.\n\n## Validation Rules\n\nThese 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\n\n| Field | Type | Required |\n|---|---|---|\n| wsdl_url | string | |\n| update_existing | | ☑ |\n| wsdl_file | | |","parameters":[{"name":"system","in":"path","required":true,"schema":{"type":"string"},"description":"The system identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemsWsdlIngestIngestWsdlRequest"}}}},"tags":["Systems"]}}}} ``` ## Get System Endpoint > Retrieves the details for a given system endpoint. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`.\ > \ > \## 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 ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"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"]}}}}},"paths":{"/api/v1/systems/{system}/endpoints/{endpoint}":{"get":{"summary":"Get System Endpoint","description":"Retrieves the details for a given system endpoint. Note: In the Patchworks dashboard, a `system` is known as a `connector`.\n\n## Available Includes\n\nThese 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.\n\n- connector\n- connector_count\n- connectorExists\n- system\n- system_count\n- systemExists\n- entityType\n- entityType_count\n- entityTypeExists\n- entityType.fieldTags\n- endpointTemplate\n- endpointTemplate_count\n- endpointTemplateExists\n- variables\n- variables_count\n- variablesExists\n- authenticationImplementations\n- authenticationImplementations_count\n- authenticationImplementationsExists\n- fieldTags\n- fieldTags_count\n- fieldTagsExists\n- filters\n- filters_count\n- filtersExists\n- endpointSchema\n- endpointSchema_count\n- endpointSchemaExists\n- preScriptVersion\n- preScriptVersion_count\n- preScriptVersionExists\n- preScriptVersion.script\n- postScriptVersion\n- postScriptVersion_count\n- postScriptVersionExists\n- postScriptVersion.script\n\n\n## Available Filters\n\nThese are the filters that can be used to specific the data to return. Please see the section on using filters for more details.\n\n- name\n- system_id\n- entity_type_id\n- endpoint\n- direction\n- http_method\n- endpoint_template_id\n- data_type\n- deprecated_at\n- data_path\n- body_format\n\n\n## Available Fields\n\nThese are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.\n\n- endpoints.id\n- endpoints.name\n- endpoints.entity_type_id\n- endpoints.direction\n- endpoints.http_method\n\n\n## Available Sorts\n\nThese are the sorts that can be used order the returned data. Please see the section on using sorting for more details.\n\n- name\n- system_id\n- entity_type_id\n- endpoint\n- direction\n- http_method\n- endpoint_template_id\n- data_type\n- deprecated_at\n- data_path\n- body_format","parameters":[{"name":"system","in":"path","required":true,"schema":{"type":"string"},"description":"The system identifier."},{"name":"endpoint","in":"path","required":true,"schema":{"type":"string"},"description":"The endpoint identifier."},{"name":"filter[name]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by name."},{"name":"filter[system_id]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by system_id."},{"name":"filter[entity_type_id]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by entity_type_id."},{"name":"filter[endpoint]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by endpoint."},{"name":"filter[direction]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by direction."},{"name":"filter[http_method]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by http_method."},{"name":"filter[endpoint_template_id]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by endpoint_template_id."},{"name":"filter[data_type]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by data_type."},{"name":"filter[deprecated_at]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by deprecated_at."},{"name":"filter[data_path]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by data_path."},{"name":"filter[body_format]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by body_format."},{"name":"include","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of relationships to include. Available: connector, system, entityType, entityType.fieldTags, endpointTemplate, variables, authenticationImplementations, fieldTags, filters, endpointSchema, preScriptVersion.script, postScriptVersion.script"},{"name":"sort","in":"query","required":false,"schema":{"type":"string"},"description":"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"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1},"description":"Page number for pagination."},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Number of results per page."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndpointsResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Systems"]}}}} ``` ## Update System Endpoint > Updates an existing system endpoint. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`.\ > \ > \## 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 | | ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"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"]}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"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 \\-&\\+_]+$"}}}}},"paths":{"/api/v1/systems/{system}/endpoints/{endpoint}":{"put":{"summary":"Update System Endpoint","description":"Updates an existing system endpoint. Note: In the Patchworks dashboard, a `system` is known as a `connector`.\n\n## Validation Rules\n\nThese 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\n\n| Field | Type | Required |\n|---|---|---|\n| name | string | |\n| entity_type_id | integer | |\n| endpoint | string | |\n| direction | string | |\n| returns_multiple_records | | |\n| http_method | string | |\n| data_type | string | |\n| pagination_method | string | |\n| schema | string | |\n| endpoint_template_id | integer | |\n| data_path | string | |\n| body_format | string | |\n| raw_body | string | |\n| deprecated_at | | |\n| help_link | string | |\n| pre_script_version_id | string | |\n| post_script_version_id | string | |\n| disable_header_addition | | |\n| response_encoding | string | |","parameters":[{"name":"system","in":"path","required":true,"schema":{"type":"string"},"description":"The system identifier."},{"name":"endpoint","in":"path","required":true,"schema":{"type":"string"},"description":"The endpoint identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndpointsResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemsUpdateEndpointsRequest"}}}},"tags":["Systems"]}}}} ``` ## Delete System Endpoint > Deletes an existing system endpoint. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`. ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"MessageResponse":{"type":"object","properties":{"message":{"type":"string"}}}}},"paths":{"/api/v1/systems/{system}/endpoints/{endpoint}":{"delete":{"summary":"Delete System Endpoint","description":"Deletes an existing system endpoint. Note: In the Patchworks dashboard, a `system` is known as a `connector`.","parameters":[{"name":"system","in":"path","required":true,"schema":{"type":"string"},"description":"The system identifier."},{"name":"endpoint","in":"path","required":true,"schema":{"type":"string"},"description":"The endpoint identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Systems"]}}}} ``` ## Clone System Endpoint > Clones a given system endpoint. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`. ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}},"paths":{"/api/v1/systems/{system}/endpoints/{endpoint}/clone":{"post":{"summary":"Clone System Endpoint","description":"Clones a given system endpoint. Note: In the Patchworks dashboard, a `system` is known as a `connector`.","parameters":[{"name":"system","in":"path","required":true,"schema":{"type":"string"},"description":"The system identifier."},{"name":"endpoint","in":"path","required":true,"schema":{"type":"string"},"description":"The endpoint identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Systems"]}}}} ``` ## List System Endpoint Metrics > Retrieves metrics for endpoints associated with a given system. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`.\ > \ > \## 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 | | | ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"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}}}}},"paths":{"/api/v1/systems/{system}/endpoint-metrics":{"get":{"summary":"List System Endpoint Metrics","description":"Retrieves metrics for endpoints associated with a given system. Note: In the Patchworks dashboard, a `system` is known as a `connector`.\n\n## Validation Rules\n\nThese 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\n\n| Field | Type | Required |\n|---|---|---|\n| interval_start | | |\n| interval_end | | |\n| interval_unit | string | |\n| model_type | string | |\n| key | string | |\n| keys | | |\n| managed_companies | | |","parameters":[{"name":"system","in":"path","required":true,"schema":{"type":"string"},"description":"The system identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemsListResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Systems"]}}}} ``` ## List System Authentication Implementations > Lists all authentication implementations for a given system. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`.\ > \ > \## 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 ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"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}}}}},"paths":{"/api/v1/systems/{system}/authentication-implementations":{"get":{"summary":"List System Authentication Implementations","description":"Lists all authentication implementations for a given system. Note: In the Patchworks dashboard, a `system` is known as a `connector`.\n\n## Pagination\n\nPagination is available for this request. Please see the section on using pagination for more details.\n\n## Available Includes\n\nThese 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.\n\n- system\n- system_count\n- systemExists\n- system.systemType\n- authenticationType\n- authenticationType_count\n- authenticationTypeExists\n- variables\n- variables_count\n- variablesExists\n- endpoints\n- endpoints_count\n- endpointsExists\n- preScriptVersion\n- preScriptVersion_count\n- preScriptVersionExists\n- preScriptVersion.script\n- postScriptVersion\n- postScriptVersion_count\n- postScriptVersionExists\n- postScriptVersion.script\n\n\n## Available Filters\n\nThese are the filters that can be used to specific the data to return. Please see the section on using filters for more details.\n\n- name\n- endpoint\n- method\n- additional_endpoint_1\n- additional_endpoint_2\n- system_id\n- authentication_type_id\n- version\n\n\n\n\n## Available Sorts\n\nThese are the sorts that can be used order the returned data. Please see the section on using sorting for more details.\n\n- name\n- endpoint\n- method\n- additional_endpoint_1\n- additional_endpoint_2\n- system_id\n- authentication_type_id\n- version","parameters":[{"name":"system","in":"path","required":true,"schema":{"type":"string"},"description":"The system identifier."},{"name":"filter[name]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by name."},{"name":"filter[endpoint]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by endpoint."},{"name":"filter[method]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by method."},{"name":"filter[additional_endpoint_1]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by additional_endpoint_1."},{"name":"filter[additional_endpoint_2]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by additional_endpoint_2."},{"name":"filter[system_id]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by system_id."},{"name":"filter[authentication_type_id]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by authentication_type_id."},{"name":"filter[version]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by version."},{"name":"include","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of relationships to include. Available: system, system.systemType, authenticationType, variables, endpoints, preScriptVersion.script, postScriptVersion.script"},{"name":"sort","in":"query","required":false,"schema":{"type":"string"},"description":"Sort field. Prefix with - for descending. Available: name, endpoint, method, additional_endpoint_1, additional_endpoint_2, system_id, authentication_type_id, version"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1},"description":"Page number for pagination."},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Number of results per page."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationImplementationsListResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Systems"]}}}} ``` ## Create System Authentication Implementation > Creates a new authentication implementation for a given system. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`.\ > \ > \## 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 | | ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"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"}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"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"]}}},"paths":{"/api/v1/systems/{system}/authentication-implementations":{"post":{"summary":"Create System Authentication Implementation","description":"Creates a new authentication implementation for a given system. Note: In the Patchworks dashboard, a `system` is known as a `connector`.\n\n## Validation Rules\n\nThese 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\n\n| Field | Type | Required |\n|---|---|---|\n| name | string | ☑ |\n| endpoint | string | ☑ |\n| method | string | ☑ |\n| data_type | | |\n| body_format | | |\n| additional_endpoint_1 | string | |\n| additional_endpoint_2 | string | |\n| timeout | integer | |\n| authentication_type_id | | ☑ |\n| help_link | string | |","parameters":[{"name":"system","in":"path","required":true,"schema":{"type":"string"},"description":"The system identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationImplementationsResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemsStoreAuthenticationImplementationsRequest"}}}},"tags":["Systems"]}}}} ``` ## Get System Authentication Implementation > Retrieves a given authentication implementation for a system. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`.\ > \ > \## 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 ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"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"}}}}},"paths":{"/api/v1/systems/{system}/authentication-implementations/{authentication_implementation}":{"get":{"summary":"Get System Authentication Implementation","description":"Retrieves a given authentication implementation for a system. Note: In the Patchworks dashboard, a `system` is known as a `connector`.\n\n## Available Includes\n\nThese 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.\n\n- system\n- system_count\n- systemExists\n- system.systemType\n- authenticationType\n- authenticationType_count\n- authenticationTypeExists\n- variables\n- variables_count\n- variablesExists\n- endpoints\n- endpoints_count\n- endpointsExists\n- preScriptVersion\n- preScriptVersion_count\n- preScriptVersionExists\n- preScriptVersion.script\n- postScriptVersion\n- postScriptVersion_count\n- postScriptVersionExists\n- postScriptVersion.script\n\n\n## Available Filters\n\nThese are the filters that can be used to specific the data to return. Please see the section on using filters for more details.\n\n- name\n- endpoint\n- method\n- additional_endpoint_1\n- additional_endpoint_2\n- system_id\n- authentication_type_id\n- version\n\n\n\n\n## Available Sorts\n\nThese are the sorts that can be used order the returned data. Please see the section on using sorting for more details.\n\n- name\n- endpoint\n- method\n- additional_endpoint_1\n- additional_endpoint_2\n- system_id\n- authentication_type_id\n- version","parameters":[{"name":"system","in":"path","required":true,"schema":{"type":"string"},"description":"The system identifier."},{"name":"authentication_implementation","in":"path","required":true,"schema":{"type":"string"},"description":"The authentication implementation identifier."},{"name":"filter[name]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by name."},{"name":"filter[endpoint]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by endpoint."},{"name":"filter[method]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by method."},{"name":"filter[additional_endpoint_1]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by additional_endpoint_1."},{"name":"filter[additional_endpoint_2]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by additional_endpoint_2."},{"name":"filter[system_id]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by system_id."},{"name":"filter[authentication_type_id]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by authentication_type_id."},{"name":"filter[version]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by version."},{"name":"include","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of relationships to include. Available: system, system.systemType, authenticationType, variables, endpoints, preScriptVersion.script, postScriptVersion.script"},{"name":"sort","in":"query","required":false,"schema":{"type":"string"},"description":"Sort field. Prefix with - for descending. Available: name, endpoint, method, additional_endpoint_1, additional_endpoint_2, system_id, authentication_type_id, version"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1},"description":"Page number for pagination."},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Number of results per page."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationImplementationsResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Systems"]}}}} ``` ## Update System Authentication Implementation > Updates an existing authentication implementation for a system. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`.\ > \ > \## 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 ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"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"}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"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"}}}}},"paths":{"/api/v1/systems/{system}/authentication-implementations/{authentication_implementation}":{"put":{"summary":"Update System Authentication Implementation","description":"Updates an existing authentication implementation for a system. Note: In the Patchworks dashboard, a `system` is known as a `connector`.\n\n## Validation Rules\n\nThese 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\n\n| Field | Type | Required |\n|---|---|---|\n| name | string | |\n| endpoint | string | |\n| method | string | |\n| data_type | | |\n| body_format | | |\n| additional_endpoint_1 | string | |\n| additional_endpoint_2 | string | |\n| timeout | integer | |\n| authentication_type_id | | |\n| pre_script_version_id | string | |\n| post_script_version_id | string | |\n| help_link | string | |\n\n\n\n\n\n## Available Includes\n\nThese 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.\n\n- system\n- system_count\n- systemExists\n- system.systemType\n- authenticationType\n- authenticationType_count\n- authenticationTypeExists\n- variables\n- variables_count\n- variablesExists\n- endpoints\n- endpoints_count\n- endpointsExists\n- preScriptVersion\n- preScriptVersion_count\n- preScriptVersionExists\n- preScriptVersion.script\n- postScriptVersion\n- postScriptVersion_count\n- postScriptVersionExists\n- postScriptVersion.script\n\n\n## Available Filters\n\nThese are the filters that can be used to specific the data to return. Please see the section on using filters for more details.\n\n- name\n- endpoint\n- method\n- additional_endpoint_1\n- additional_endpoint_2\n- system_id\n- authentication_type_id\n- version\n\n\n\n\n## Available Sorts\n\nThese are the sorts that can be used order the returned data. Please see the section on using sorting for more details.\n\n- name\n- endpoint\n- method\n- additional_endpoint_1\n- additional_endpoint_2\n- system_id\n- authentication_type_id\n- version","parameters":[{"name":"system","in":"path","required":true,"schema":{"type":"string"},"description":"The system identifier."},{"name":"authentication_implementation","in":"path","required":true,"schema":{"type":"string"},"description":"The authentication implementation identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationImplementationsResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemsUpdateAuthenticationImplementationsRequest"}}}},"tags":["Systems"]}}}} ``` ## Delete System Authentication Implementation > Deletes a given authentication implementation for a system. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`. ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"MessageResponse":{"type":"object","properties":{"message":{"type":"string"}}}}},"paths":{"/api/v1/systems/{system}/authentication-implementations/{authentication_implementation}":{"delete":{"summary":"Delete System Authentication Implementation","description":"Deletes a given authentication implementation for a system. Note: In the Patchworks dashboard, a `system` is known as a `connector`.","parameters":[{"name":"system","in":"path","required":true,"schema":{"type":"string"},"description":"The system identifier."},{"name":"authentication_implementation","in":"path","required":true,"schema":{"type":"string"},"description":"The authentication implementation identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Systems"]}}}} ``` ## List System Variables > List all variables for a given system. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`.\ > \ > \## 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 ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"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}}}}},"paths":{"/api/v1/systems/{system}/variables":{"get":{"summary":"List System Variables","description":"List all variables for a given system. Note: In the Patchworks dashboard, a `system` is known as a `connector`.\n\n## Pagination\n\nPagination is available for this request. Please see the section on using pagination for more details.\n\n\n\n## Available Filters\n\nThese are the filters that can be used to specific the data to return. Please see the section on using filters for more details.\n\n- label\n- key\n- value\n\n\n\n\n## Available Sorts\n\nThese are the sorts that can be used order the returned data. Please see the section on using sorting for more details.\n\n- label\n- key\n- value","parameters":[{"name":"system","in":"path","required":true,"schema":{"type":"string"},"description":"The system identifier."},{"name":"filter[label]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by label."},{"name":"filter[key]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by key."},{"name":"filter[value]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by value."},{"name":"sort","in":"query","required":false,"schema":{"type":"string"},"description":"Sort field. Prefix with - for descending. Available: label, key, value"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1},"description":"Page number for pagination."},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Number of results per page."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariablesListResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Systems"]}}}} ``` ## Create System Variable > Creates a new variable for a given system. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`.\ > \ > \## 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 | | | ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"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"}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"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"]}}},"paths":{"/api/v1/systems/{system}/variables":{"post":{"summary":"Create System Variable","description":"Creates a new variable for a given system. Note: In the Patchworks dashboard, a `system` is known as a `connector`.\n\n## Validation Rules\n\nThese 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\n\n| Field | Type | Required |\n|---|---|---|\n| label | string | ☑ |\n| key | string | ☑ |\n| value | string | |\n| secret | | |\n| pivot.alias | string | |\n| pivot.configurable | | |\n| pivot.required | | |\n| pivot.advanced | | |","parameters":[{"name":"system","in":"path","required":true,"schema":{"type":"string"},"description":"The system identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariablesResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemsStoreVariablesRequest"}}}},"tags":["Systems"]}}}} ``` ## Delete System Variable > Deletes a given system variable. Note: In the Patchworks dashboard, a \`system\` is known as a \`connector\`. ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Systems"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"MessageResponse":{"type":"object","properties":{"message":{"type":"string"}}}}},"paths":{"/api/v1/systems/{system}/variables/{variable}":{"delete":{"summary":"Delete System Variable","description":"Deletes a given system variable. Note: In the Patchworks dashboard, a `system` is known as a `connector`.","parameters":[{"name":"system","in":"path","required":true,"schema":{"type":"string"},"description":"The system identifier."},{"name":"variable","in":"path","required":true,"schema":{"type":"string"},"description":"The variable identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Systems"]}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://doc.wearepatchworks.com/product-documentation/api-reference/connectors-and-instances/systems.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.